This class manage piwik statistics management through AlternC, using piwik's "API". More...

Public Member Functions
	hook_menu ()

	m_piwik ()
	Constructor. More...

	hook_admin_del_member ()
	hook called when an AlternC account is deleted More...

	hook_quota_get ()
	Returns the used quota for the $name service for the current user. More...

	url ()

	user_add ($user_login, $user_mail)

	user_edit ()
	Change a user @TODO: code this. More...

	get_site_access ($user_login)

	get_users_access_from_site ($site_id)

	get_user ($user_login)

	get_alternc_sites ($force=false)

	get_alternc_users ()

	get_users_url_infos ()

	user_has_sites ()
	does this user has piwik websites configured in AlternC ? More...

	user_delete ($piwik_user_login)
	Delete a piwik user don't delete it locally unless it has been remotely deleted. More...

	users_list ()

	user_checkremote ($puser_id)

	user_remoteauth ()

	user_access ()

	site_list ()

	site_js_tag ($site_id)

	get_site_list ()

	site_add ($siteName, $urls, $ecommerce=FALSE)

	site_delete ($site_id)

	site_set_user_right ($site_id, $login, $right)

	site_alias_add ()

	clean_user_name ($username)
	return a clean username with a unique prefix per account More...

	dev ()

	call_page ($module, $method, $arguments=array(), $output='JSON')

	call_privileged_page ($module, $method, $arguments=array(), $output='JSON')

Public Attributes
	$piwik_server_uri

	$piwik_admin_token

	$alternc_users

	$alternc_sites

Detailed Description

This class manage piwik statistics management through AlternC, using piwik's "API".

Copyright: AlternC-Team 2000-2017 https://alternc.com/

Definition at line 26 of file m_piwik.php.

Member Function Documentation

◆ call_page()

m_piwik::call_page	(	$module,
		$method,
		$arguments = `array()`,
		$output = `'JSON'`
	)

Parameters

string	$module
string	$method

Definition at line 475 of file m_piwik.php.

                                                                                {
         global $msg;
  
         $msg->debug("piwik","call_page");
  
         $url = sprintf('%s/?module=%s&method=%s&format=%s', $this->piwik_server_uri, $module, $method, $output);
         foreach ($arguments AS $k=>$v)
             $url .= sprintf('&%s=%s', urlencode($k), $v); //  urlencode($v));
  
         $page_content = file_get_contents($url);
         if ($page_content === FALSE) {
             $msg->raise("ERROR", "piwik", _("Unable to reach the API"));
             return FALSE;
         }
  
         if ($output == 'JSON') {
             $api_data = json_decode($page_content);
             if ($api_data === FALSE) {
                 $msg->raise("ERROR", "piwik", _("Error while decoding response from the API"));
                 return FALSE;
             }
  
             return $api_data;
         } else {
             $msg->raise("ERROR", "piwik", _("Other format than JSON is not implemented yet"));
             return FALSE;
         }
     }

References $msg.

Referenced by call_privileged_page().

◆ call_privileged_page()

m_piwik::call_privileged_page	(	$module,
		$method,
		$arguments = `array()`,
		$output = `'JSON'`
	)

Parameters

string	$module
string	$method

Definition at line 509 of file m_piwik.php.

                                                                                           {
         global $msg;
  
         $msg->debug("piwik","call_privileged_page");
  
         $arguments['token_auth'] = $this->piwik_admin_token;
         return $this->call_page($module, $method, $arguments, $output);
     }

References $msg, $piwik_admin_token, and call_page().

Referenced by get_site_access(), get_site_list(), get_user(), get_users_access_from_site(), site_add(), site_delete(), site_js_tag(), site_list(), site_set_user_right(), user_add(), user_delete(), and users_list().

◆ clean_user_name()

m_piwik::clean_user_name ( $username )

return a clean username with a unique prefix per account

Definition at line 457 of file m_piwik.php.

                                         {
         global $admin, $cuid, $db;
         $escaped_name=$db->quote(trim($username));
         $escaped_name=preg_replace("/^'(.*)'/", "\\1", $escaped_name);
         return 'alternc_' . $admin->get_login_by_uid($cuid) . '_' . $escaped_name;
     }

References $cuid, $db, and $username.

Referenced by user_add().

◆ dev()

m_piwik::dev ( )

Definition at line 465 of file m_piwik.php.

                    {
         // $this->call_page('module', 'method', array('user' => 'fser', 'pass' => 'toto'));
         // return $this->users_list();
     }

◆ get_alternc_sites()

m_piwik::get_alternc_sites ( $force = false )

Definition at line 187 of file m_piwik.php.

                                              {
         global $db, $cuid, $msg;
         
         if (!count($this->alternc_sites) || $force) {
             $db->query("SELECT piwik_id AS site_id FROM piwik_sites WHERE uid= ? ;", array($cuid));
             while ($db->next_record())
                 $this->alternc_sites[]=$db->f('site_id');
         }
         return $this->alternc_sites;
     }

References $alternc_sites, $cuid, $db, and $msg.

Referenced by get_users_access_from_site(), site_add(), and site_list().

◆ get_alternc_users()

m_piwik::get_alternc_users ( )

Definition at line 198 of file m_piwik.php.

                                  {
         global $db, $cuid, $msg;
  
         if (!count($this->alternc_users)) {
             $db->query("SELECT login FROM piwik_users WHERE uid= ?;", array($cuid));
             while ($db->next_record())
                 $this->alternc_users[]=$db->f('login');
         }
         return $this->alternc_users;
     }

References $alternc_users, $cuid, $db, and $msg.

Referenced by get_users_access_from_site().

◆ get_site_access()

m_piwik::get_site_access ( $user_login )

Definition at line 140 of file m_piwik.php.

                                           {
         return $this->call_privileged_page('API', 'UsersManager.getSitesAccessFromUser', array('userLogin' => $user_login));
     }

References call_privileged_page().

◆ get_site_list()

m_piwik::get_site_list ( )

Definition at line 366 of file m_piwik.php.

     {
         return $this->call_privileged_page('API', 'SitesManager.getAllSites',
                                            array('filter_limit' => -1));
     }

References call_privileged_page().

◆ get_user()

m_piwik::get_user ( $user_login )

Parameters

string $user_login

Definition at line 177 of file m_piwik.php.

                                    {
         $api_data = $this->call_privileged_page('API', 'UsersManager.getUser', array('userLogin' => $user_login));
  
         if ($api_data)
             return $api_data[0];
         else
             return FALSE;
     }

References call_privileged_page().

Referenced by user_add().

◆ get_users_access_from_site()

m_piwik::get_users_access_from_site ( $site_id )

Definition at line 144 of file m_piwik.php.

                                                   {
         global $msg, $cuid;
  
         $msg->debug("piwik","get_users_access_from_site");
  
         $this->get_alternc_sites();
         $this->get_alternc_users();
         if (!is_numeric($site_id)) {
             $msg->raise("ERROR", 'piwik', 'site_id must be numeric');
             return FALSE;
         }
         if (!in_array($site_id, $this->alternc_sites)) {
             $msg->raise("ERROR", 'piwik', "you don't own this piwik website");
             return FALSE;
         }
  
         $api_data = $this->call_privileged_page('API', 'UsersManager.getUsersAccessFromSite', array('idSite' => $site_id));
         if ($api_data !== FALSE) {
             $api_data = $api_data[0]; // Data is in the first column
             foreach ($this->alternc_users AS $key=>$user) {
                 if (!array_key_exists($user, $api_data)) {                                                            
                     $api_data->$user = 'noaccess';                                                                
                 } 
             }
             return $api_data;
         }
         else return FALSE; 
     }

References $cuid, $key, $msg, $user, call_privileged_page(), get_alternc_sites(), and get_alternc_users().

Referenced by get_users_url_infos().

◆ get_users_url_infos()

m_piwik::get_users_url_infos ( )

Definition at line 210 of file m_piwik.php.

                                    {
         global $db,$cuid, $msg;
         $infos_user = array();
         $api_calls = array();
  
  
         $db->query("SELECT login, passwd, s.piwik_id as id FROM piwik_users as u INNER JOIN piwik_sites as s on u.uid = s.uid WHERE u.uid = $cuid");
         while ($db->next_record()) {
             $id = $db->f('id');
             $login = $db->f('login');
  
             if (!isset($infos_user[$id]))
                 $infos_user[$id] = array();
  
             if (!isset($api_calls[$id]))
                 $api_calls[$id] = $this->get_users_access_from_site($id);
  
             foreach ($api_calls[$id] as $l => $cred) {
                 if ($l == $login)
                     $infos_user[$id][] = array('login' => $login, 'password' => $db->f('passwd'), 'cred' => $cred);
             }
         }
  
         return $infos_user;
     }

References $cuid, $db, $id, $login, $msg, and get_users_access_from_site().

◆ hook_admin_del_member()

m_piwik::hook_admin_del_member ( )

hook called when an AlternC account is deleted

Definition at line 64 of file m_piwik.php.

                                      {
         //FIXME : implement the hook_admin_del_member for piwik
         return true;
     }

◆ hook_menu()

m_piwik::hook_menu ( )

Definition at line 32 of file m_piwik.php.

                          {
         global $quota;
         if ( empty($this->piwik_server_uri) || empty($this->piwik_admin_token)) return false;
  
         $obj = array(
             'title'       => _("Piwik statistics"),
             'link'        => 'toggle',
             'pos'         => 115,
             'links'       => array(
                 array( 'txt' => _("Piwik Users"), 'url' => 'piwik_userlist.php'),
                 array( 'txt' => _("Piwik Sites"), 'url' => 'piwik_sitelist.php'),
             ),
         ) ;
  
         return $obj;
     }

◆ hook_quota_get()

m_piwik::hook_quota_get ( )

Returns the used quota for the $name service for the current user.

Parameters

$name string name of the quota

Returns: integer the number of service used or false if an error occured @access private

Definition at line 76 of file m_piwik.php.

                               {
         global $db, $cuid;
         $db->query("SELECT COUNT(id) AS nb FROM piwik_sites WHERE uid= ? ;", array($cuid));
         $q=Array("name"=>"piwik", "description"=>_("Statistics through Piwik accounts"), "used"=>0);
         if ($db->next_record()) {
             $q['used']=$db->f('nb');
         }
         return $q;
     }

References $cuid, $db, and $q.

◆ m_piwik()

m_piwik::m_piwik ( )

Constructor.

Definition at line 53 of file m_piwik.php.

                        {
         $this->piwik_server_uri=variable_get('piwik_server_uri','','Remote Piwik server uri');
         $this->piwik_admin_token=variable_get('piwik_admin_token','','Remote Piwik super-admin token');
         $this->alternc_users=array();
         $this->alternc_sites=array();
     }

References variable_get().

◆ site_add()

m_piwik::site_add	(	$siteName,
		$urls,
		$ecommerce = `FALSE`
	)

Definition at line 373 of file m_piwik.php.

                                                             {
         global $db, $cuid, $piwik, $msg;
  
         $msg->log("piwik","site_add");
  
         $this->get_alternc_sites();
         $urls = is_array($urls) ? implode(',', $urls) : $urls;
         $api_data = $this->call_privileged_page('API', 'SitesManager.addSite', array('siteName' => $siteName, 'urls' => $urls));
  
         if ($api_data->value) {
             $id_site = $api_data->value;
  
             // Ajout de donner auto les droits de lecture à ce nouvel utilisateur pour le site qu'il a ajouté
             $userslist = $piwik->users_list();
             $api_data = $this->call_privileged_page('API', 'UsersManager.setUserAccess', array('userLogin' => $userslist[0]->login, 'idSites' => $id_site, 'access' => 'view'));
  
             if ($api_data->result == 'success') {
                 // On enregistre le site dans alternC
                 $db->query("INSERT INTO piwik_sites set uid= ? , piwik_id= ? ", array($cuid, $id_site));
  
                 // Permet de prendre en compte le site qu'on vient de créer dans la page quis'affiche
                 $this->alternc_sites = $this->get_alternc_sites(true);
                 return TRUE;
             }
             return TRUE;
         } else
             return FALSE;
     }

References $cuid, $db, $msg, $userslist, call_privileged_page(), and get_alternc_sites().

◆ site_alias_add()

m_piwik::site_alias_add ( )

Definition at line 448 of file m_piwik.php.

                               {
         // FIXME
         return true;
     }

◆ site_delete()

m_piwik::site_delete ( $site_id )

Definition at line 405 of file m_piwik.php.

                                    {
         global $db, $cuid, $msg;
  
         $msg->log("piwik","site_delete");
     
         $db->query("SELECT COUNT(id) AS cnt FROM piwik_sites WHERE uid= ? AND piwik_id= ? ;", array($cuid, $site_id));
         $db->next_record();
  
         if ($db->f('cnt') == 1) {
             $api_data = $this->call_privileged_page('API', 'SitesManager.deleteSite', array('idSite' => $site_id));
             if ($api_data->result == 'success') {
                 return $db->query("DELETE FROM piwik_sites where uid= ? AND piwik_id= ? LIMIT 1", array($cuid, $site_id));
             } else {
                 return FALSE;
             }
         } else {
             $msg->raise("ERROR", "piwik", _("You are not allowed to delete the statistics of this website"));
             return FALSE;
         }
  
         return true;
     }

References $cuid, $db, $msg, and call_privileged_page().

◆ site_js_tag()

m_piwik::site_js_tag ( $site_id )

Definition at line 361 of file m_piwik.php.

                                    {
         return $this->call_privileged_page('API', 'SitesManager.getJavascriptTag', array('idSite' => $site_id, 'piwikUrl' => $this->piwik_server_uri))->value;
     }

References call_privileged_page().

◆ site_list()

m_piwik::site_list ( )

Definition at line 323 of file m_piwik.php.

                          {
         global $msg;
  
         $msg->debug("piwik","site_list");
  
         $this->get_alternc_sites();
         $api_data = $this->call_privileged_page('API', 'SitesManager.getAllSites',
                                                 array('filter_limit' => -1));
         $data = array();
  
         if($api_data) {
             foreach ($api_data AS $site) {
  
                 if (!in_array($site->idsite, $this->alternc_sites)) 
                     continue;
  
                 $item = new stdClass();
  
                 $item->id       = $site->idsite;
                 $item->name     = $site->name;
                 $item->main_url = $site->main_url;
  
                 $user_data = $this->call_privileged_page('API', 'UsersManager.getUsersAccessFromSite', array('idSite' => $site->idsite));
  
                 //if (is_array($user_data)) {
                 // printvar($user_data);
                 //} else if(is_object($user_data)) {
                 $item->rights = $user_data[0];
                 //}
  
                 $data[] = $item;
             }
             return $data;
         } else
             return FALSE;
     }

References $msg, call_privileged_page(), and get_alternc_sites().

◆ site_set_user_right()

m_piwik::site_set_user_right	(	$site_id,
		$login,
		$right
	)

Definition at line 429 of file m_piwik.php.

     {
         global $msg;
  
         $msg->log("piwik","site_set_user_right");
  
         if (!in_array($right, array('noaccess', 'view', 'admin')))
             return FALSE;
         $api_data = $this->call_privileged_page('API', 'UsersManager.setUserAccess', array('userLogin' => $login, 'access' => $right, 'idSites' => $site_id));
         if ($api_data->result == 'success') {
             return TRUE;
         } else {
             $msg->raise("ERROR", 'piwik', $api_data->messsage);
             return FALSE;
         }
     }

References $login, $msg, and call_privileged_page().

◆ url()

m_piwik::url ( )

Definition at line 87 of file m_piwik.php.

                    {
         return $this->piwik_server_uri;
     }

References $piwik_server_uri.

◆ user_access()

m_piwik::user_access ( )

Definition at line 312 of file m_piwik.php.

                            {
         // FIXME
         return true;
     }

◆ user_add()

m_piwik::user_add	(	$user_login,
		$user_mail
	)

Definition at line 96 of file m_piwik.php.

                                                {
         global $db, $mem, $cuid, $msg;
  
         $msg->log("piwik","user_add");
  
         if (empty($user_login) || is_null($user_login) || empty($user_mail) || is_null($user_mail)) {
             $msg->raise("ERROR", "piwik", _("All fields are mandatory"));
             return false;
         }
  
         // Validate the email syntax:
         if (!filter_var($user_mail, FILTER_VALIDATE_EMAIL)) {
             $msg->raise("ERROR", "piwik", _("The email you entered is syntaxically incorrect"));
             return false;
         }
  
         $user_login = $this->clean_user_name($user_login);
         $user_pass  = create_pass();
         $user_alias = $user_login;
  
         $api_data = $this->call_privileged_page('API', 'UsersManager.addUser', array('userLogin' => $user_login, 'password' => $user_pass, 'email' => $user_mail, 'alias' => $user_alias), 'JSON'); 
         if ($api_data) {
             if ($api_data->result === 'success') {
                 $user = $this->get_user($user_login);
                 $user_creation_date = $user->date_registered;
                 $ret_value = $db->query("INSERT INTO piwik_users (uid, passwd, login, created_date) VALUES ( ?, ?, ?, ?);", array($cuid, md5($user_pass), $user_login, $user_creation_date));
                 return $ret_value;
             } else {
                 $msg->raise("ERROR", "piwik", $api_data->message);
                 return FALSE;
             }
         } else { // api_data = false -> error is already filled
             return FALSE;
         }
     }

References $cuid, $db, $mem, $msg, $user, call_privileged_page(), clean_user_name(), create_pass(), and get_user().

◆ user_checkremote()

m_piwik::user_checkremote ( $puser_id )

Definition at line 299 of file m_piwik.php.

                                          {
         //FIXME
         return true;
     }

◆ user_delete()

m_piwik::user_delete ( $piwik_user_login )

Delete a piwik user don't delete it locally unless it has been remotely deleted.

Definition at line 260 of file m_piwik.php.

                                             {
         global $db, $cuid, $msg;
  
         $msg->log("piwik","user_delete");
     
         $db->query("SELECT created_date, COUNT(id) AS cnt FROM piwik_users WHERE uid= ? AND login= ? ", array($cuid, $piwik_user_login));
         $db->next_record();
  
         if ($db->f('cnt') == 1) {
             $api_data = $this->call_privileged_page('API', 'UsersManager.deleteUser', array('userLogin' => $piwik_user_login));
             if ($api_data->result == 'success') {
                 return $db->query("DELETE FROM piwik_users WHERE uid= ? AND login= ? ;", array($cuid, $piwik_user_login));
             }
             else {
                 return FALSE;
             }
         } else {
             $msg->raise("ERROR", "piwik", _("You are not allowed to delete the statistics of this website"));
             return FALSE;
         }
     }

References $cuid, $db, $msg, and call_privileged_page().

◆ user_edit()

m_piwik::user_edit ( )

Change a user @TODO: code this.

Definition at line 136 of file m_piwik.php.

                          {
         return true;
     }

◆ user_has_sites()

m_piwik::user_has_sites ( )

does this user has piwik websites configured in AlternC ?

Definition at line 240 of file m_piwik.php.

                               {
         global $db, $cuid, $msg;
  
         $msg->debug("piwik","user_has_sites");
  
         $db->query("SELECT id FROM piwik_users WHERE uid='$cuid'");
         if ($db->num_rows() <= 1) {
             $db->query("SELECT id FROM piwik_sites WHERE uid='$cuid'");
             if ($db->num_rows() > 0)
                 return true;
         }
  
         return false;
     }

References $cuid, $db, and $msg.

◆ user_remoteauth()

m_piwik::user_remoteauth ( )

Definition at line 306 of file m_piwik.php.

                                {
         //FIXME
         return true;
     }

◆ users_list()

m_piwik::users_list ( )

Definition at line 283 of file m_piwik.php.

                           { 
         global $db, $cuid, $msg;
  
         $msg->debug("piwik","users_list");
  
         $db->query("SELECT login FROM piwik_users WHERE uid = ?;", array($cuid));
         if ($db->num_rows() == 0)
             return array();
         $users = '';
         while ($db->next_record())
             $users .= ($users !== '') ? ',' . $db->f('login') : $db->f('login');
         return $this->call_privileged_page('API', 'UsersManager.getUsers', array('userLogins' => $users)); 
     }

References $cuid, $db, $msg, and call_privileged_page().

Member Data Documentation

◆ $alternc_sites

m_piwik::$alternc_sites

Definition at line 30 of file m_piwik.php.

Referenced by get_alternc_sites().

◆ $alternc_users

m_piwik::$alternc_users

Definition at line 29 of file m_piwik.php.

Referenced by get_alternc_users().

◆ $piwik_admin_token

m_piwik::$piwik_admin_token

Definition at line 28 of file m_piwik.php.

Referenced by call_privileged_page().

◆ $piwik_server_uri

m_piwik::$piwik_server_uri

Definition at line 27 of file m_piwik.php.

Referenced by url().

The documentation for this class was generated from the following file:

bureau/class/m_piwik.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ call_page()

◆ call_privileged_page()

◆ clean_user_name()

◆ dev()

◆ get_alternc_sites()

◆ get_alternc_users()

◆ get_site_access()

◆ get_site_list()

◆ get_user()

◆ get_users_access_from_site()

◆ get_users_url_infos()

◆ hook_admin_del_member()

◆ hook_menu()

◆ hook_quota_get()

◆ m_piwik()

◆ site_add()

◆ site_alias_add()

◆ site_delete()

◆ site_js_tag()

◆ site_list()

◆ site_set_user_right()

◆ url()

◆ user_access()

◆ user_add()

◆ user_checkremote()

◆ user_delete()

◆ user_edit()

◆ user_has_sites()

◆ user_remoteauth()

◆ users_list()

Member Data Documentation

◆ $alternc_sites

◆ $alternc_users

◆ $piwik_admin_token

◆ $piwik_server_uri