root/trunk/mw_plugin.php

<?php

//
// Open Web Analytics - An Open Source Web Analytics Framework
//
// Copyright 2006 Peter Adams. All rights reserved.
//
// Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// $Id$
//

require_once('owa_env.php');
require_once(OWA_BASE_CLASSES_DIR.'owa_php.php');
require_once "$IP/includes/SpecialPage.php";

/* MEDIAWIKI GLOBALS */
global $wgCachePages, $wgDBtype, $wgDBname, $wgDBserver, $wgDBuser, $wgDBpassword, $wgUser, $wgServer, $wgScriptPath, $wgScript;

/* OWA's MEDIAWIKI CONFIGURATION OVERRIDES */

// Public folder URI
define('OWA_PUBLIC_URL', $wgServer.$wgScriptPath.'/extensions/owa/public/');

// Build OWA's Mediawiki specific config overrides array
$owa_config = array();
$wiki_url = $wgScriptPath;

// OWA DATABASE CONFIGURATION 
// Will use Mediawiki's config valuesunless there are values present in an OWA config file.
// OWA uses this to setup it's own DB connection seperate from the one that Mediawiki uses.
$owa_config['db_type'] = $wgDBtype;
$owa_config['db_name'] = $wgDBname;
$owa_config['db_host'] = $wgDBserver;
$owa_config['db_user'] = $wgDBuser;
$owa_config['db_password'] = $wgDBpassword;

$owa_config['report_wrapper'] = 'wrapper_mediawiki.tpl';
$owa_config['images_url'] = OWA_PUBLIC_URL.'i/';
$owa_config['images_absolute_url'] = $owa_config['images_url'];
$owa_config['main_url'] = $wgScriptPath.'/index.php?title=Special:Owa';
$owa_config['main_absolute_url'] = $wgServer.$owa_config['main_url'];
$owa_config['action_url'] = $wgServer.$wgScriptPath.'/index.php?action=owa&owa_specialAction';
$owa_config['log_url'] = $wgServer.$wgScriptPath.'/index.php?action=owa&owa_logAction=1';
$owa_config['link_template'] = '%s&%s';
//$owa_config['authentication'] = 'mediawiki';
$owa_config['site_id'] = md5($wgServer.$wiki_url);
$owa_config['is_embedded'] = true;
$owa_config['delay_first_hit'] = true;

// Turn MediaWiki Caching Off
global $wgCachePages, $wgCacheEpoch;
$wgCachePages = false;
$wgCacheEpoch = 'date +%Y%m%d%H%M%S';

// Register Extension with MediaWiki
$wgExtensionFunctions[] = 'owa_main';
$wgExtensionCredits['other'][] = array( 'name' => 'Open Web Analytics for MediaWiki', 
                                                                                'author' => 'Peter Adams <peter@openwebanalytics.com>', 
                                                                                'url' => 'http://www.openwebanalytics.com' );
                                                                                
$wgExtensionCredits['specialpage'][] = array('name' => 'Open Web Analytics for MediaWiki', 
                                                                                         'author' => 'Peter Adams', 
                                                                                         'url' => 'http://www.openwebanalytics.com',
                                                                                         'description' => 'Open Web Analytics for MedaWiki');

//Load Special Page
$wgAutoloadClasses['SpecialOwa'] = __FILE__;
$wgSpecialPages['Owa'] = 'SpecialOwa';
$wgHooks['LoadAllMessages'][] = 'SpecialOwa::loadMessages';
$wgHooks['UnknownAction'][] = 'owa_actions';


/**
 * OWA Singleton Method
 *
 * Makes a singleton instance of OWA using the config array
 */
function owa_factory() {

        global $owa_config;
        
        static $owa;
        
        if(!empty($owa)):
                return $owa;
        else:
                $owa = new owa_php($owa_config);
                return $owa;
        endif;

}

/**
 * Main Mediawiki Extension method
 *
 * sets up OWA to be triggered for various hooks/actions
 */
function owa_main() {

        global $wgHooks;

        // Hook for logging Article Page Views
        $wgHooks['ArticlePageDataAfter'][] = 'owa_logArticle';
        $wgHooks['SpecialPageExecuteAfterPage'][] = 'owa_logSpecialPage';
        $wgHooks['CategoryPageView'][] = 'owa_logCategoryPage';
        
        // Hooks for adding page tracking tags 
        $wgHooks['ArticlePageDataAfter'][] = 'owa_footer';
        $wgHooks['SpecialPageExecuteAfterPage'][] = 'owa_footer';
        $wgHooks['CategoryPageView'][] = 'owa_footer';
        
        
        //SpecialPage::addPage(new OwaSpecialPage());
        
    return;
}

/**
 * Hook for OWA special actions
 *
 * This uses mediawiki's 'unknown action' hook to trigger OWA's special action handler.
 * This is setup by adding 'action=owa' to the URLs for special actions. There is 
 * probably a better way to do this so that the OWA namespace is preserved.
 *
 * @TODO figure out how to register this method to be triggered only when 'action=owa' instead of 
 *               for all unknown mediawiki actions.
 * @param object $specialPage
 * @url http://www.mediawiki.org/wiki/Manual:MediaWiki_hooks/UnknownAction
 * @return false
 */
function owa_actions() {
        
        global $wgOut;
        
        $owa = owa_factory();
    owa_set_priviledges();
        

        $wgOut->disable();
        $owa->handleSpecialActionRequest();
        
        return false;

}

/**
 * OWA Priviledges
 *
 * Populates OWA requestion container with info about the current mediawiki user.
 * This info is needed by OWA authentication system as well as to add dimensions
 * requests that are logged.
 */
function owa_set_priviledges() {

        global $wgUser;
        
        $owa = owa_factory();
        
        /*

        $owa->params['caller']['mediawiki']['user_data'] = array(
        
                                        'user_level'    => $wgUser->mGroups,
                                        'user_ID'               => $wgUser->mName,
                                        'user_login'    => $wgUser->mName,
                                        'user_email'    => $wgUser->mEmail,
                                        'user_identity' => $wgUser->mRealName,
                                        //'user_password'       => $wgUser->mPassword
                                        );
                                        
        $owa->params['u'] = 'xxxxx'.$wgUser->mName;
        $owa->params['p'] = 'xxxxxxx';//$wgUser->mPassword;
        
        */
        
        if ($owa->config['do_not_log_admins'] == true):
                if (strtolower($wgUser->mGroups) == 'sysop' || 'bureaucrat' || 'developer'):
                        $owa->params['do_not_log'] = true;
                endif;
        endif;          
        
        // preemptively set the current user info and mark as authenticated so that
        // downstream controllers don't have to authenticate
        $cu =&owa_coreAPI::getCurrentUser();
        $cu->setUserData('user_id', $wgUser->mName);
        $cu->setUserData('email_address', $wgUser->mEmail);
        $cu->setUserData('real_name', $wgUser->mRealName);
        $cu->setRole(owa_translate_role($wgUser->mGroups));
        $cu->setAuthStatus(true);

        return;
}

function owa_translate_role($role_array) {

        if (in_array("*", $level)):
                $owa_role = 'everyone';
        elseif (in_array("user", $level)):
                $owa_role = 'viewer';
        elseif (in_array("autoconfirmed", $level)):
                $owa_role = 'viewer';
        elseif (in_array("emailconfirmed", $level)):
                $owa_role = 'viewer';
        elseif (in_array("bot", $level)):
                $owa_role = 'viewer';
        elseif (in_array("sysop", $level)):
                $owa_role = 'admin';
        elseif (in_array("bureaucrat", $level)):
                $owa_role = 'admin';
        elseif (in_array("developer", $level)):
                $owa_role = 'admin';
        endif;
        
        return $owa_role;

}

/**
 * Logs Special Page Views
 *
 * @param object $specialPage
 * @return boolean
 */
function owa_logSpecialPage(&$specialPage) {
        
        global $wgUser, $wgOut;
        
        $app_params['user_name']= $wgUser->mName;
    $app_params['user_email'] = $wgUser->mEmail;
    $app_params['page_title'] = $wgOut->mPagetitle;
    $app_params['page_type'] = 'Special Page';

        // Log the request
        $owa = owa_factory();
        $owa->log($app_params);
        
        return true;
}

/**
 * Logs Category Page Views
 *
 * @param object $categoryPage
 * @return boolean
 */
function owa_logCategoryPage(&$categoryPage) {
        
        global $wgUser, $wgOut;
        
        $app_params['user_name']= $wgUser->mName;
    $app_params['user_email'] = $wgUser->mEmail;
    $app_params['page_title'] = $wgOut->mPagetitle;
    $app_params['page_type'] = 'Category';
        
        // Log the request
        $owa = owa_factory();
        $owa->log($app_params);
        
        return true;
}

/**
 * Logs Article Page Views
 *
 * @param object $article
 * @return boolean
 */
function owa_logArticle(&$article) {

        global $wgUser, $wgOut, $wgTitle;
        
        $wgTitle->invalidateCache();
        $wgOut->enableClientCache(false);
        
        
        // Setup Application Specific Properties to be Logged with request
        $app_params['user_name']= $wgUser->mName;
    $app_params['user_email'] = $wgUser->mEmail;
    $app_params['page_title'] = $article->mTitle->mTextform;
    $app_params['page_type'] = 'article';
    
        // Log the request
        $owa = owa_factory();
        $owa->log($app_params);
        
        return true;
        
}

/**
 * Adds helper page tags to Article Pages if they are needed
 *
 * @param object $article
 * @return boolean
 */
function owa_footer(&$article) {
        
        global $wgOut;
        $owa = owa_factory();
        $tags = $owa->placeHelperPageTags(false);
        
        $wgOut->addHTML($tags);
                
        return true;
}


/**
 * OWA Special Page Class
 *
 * Enables OWA to be accessed through a Mediawiki special page. 
 */
class SpecialOwa extends SpecialPage {

        function SpecialOwa() {
                SpecialPage::SpecialPage('Owa','',true);
                self::loadMessages();
        }

        function execute() {
                global $wgRequest, $wgOut, $wgUser, $wgSitename, $wgScriptPath, $wgScript, $wgServer;
                
                $this->setHeaders();
                $owa = owa_factory();
                # Get request data from, e.g.
               
                        // sets authentication priviledges
                        owa_set_priviledges();
                
                $params = array();
                
                // check to see that owa in installed.
                if (empty($owa->config['install_complete'])):

                        $site_url = $wgServer.$wgScriptPath;
                        
                        $params = array('site_id' => md5($site_url), 
                                                        'name' => $wgSitename,
                                                        'domain' => $site_url, 
                                                        'description' => '',
                                                        'do' => 'base.installStartEmbedded');
                                                        
                elseif (empty($owa->params['do'])):
                        if (empty($owa->params['view'])):
                                $params['do'] = 'base.reportDashboard';
                        endif;
                endif;
                
                                $page = $owa->handleRequest($params);

                                // switch for output scenario
                                if (empty($owa->config['install_complete'])):
                                        return $wgOut->addHTML($page);                                  
                                else:
                                        $wgOut->disable();
                                        echo $page;
                                        return;
                                endif;
                
        }

        function loadMessages() {
                static $messagesLoaded = false;
            global $wgMessageCache;
                
                        if ( $messagesLoaded ) return;
                        
                        $messagesLoaded = true;
                        
                        // this should be the only msg defined by mediawiki
                        $allMessages = array(
                                 'en' => array( 
                                         'owa' => 'Open Web Analytics'
                                         )
                                );


                        // load msgs in to mediawiki cache
                        foreach ( $allMessages as $lang => $langMessages ) {
                                   $wgMessageCache->addMessages( $langMessages, $lang );
                        }
                        
                        return true;
        }
        
}



?>