franck@0: <?php
franck@0: // $Id: og_statistics.module,v 1.2.2.1 2009/06/05 22:38:12 dereine Exp $
franck@0: 
franck@0: /**
franck@0:  * @file
franck@0:  *   Logs statistics of the organic group module.
franck@0:  *
franck@0:  * @todo
franck@0:  *   Write more inline comments.
franck@0:  *   Build a central api function.
franck@0:  *   Use the abstract api function to remove all this functions,
franck@0:  *   like og_stat_add_*, og_stat_update_*.
franck@0:  *
franck@0:  *   Remove all og_statistics_load in update/add/remove functions, its not needed there.
franck@0:  *
franck@0:  *   Make more functions use arrays instaed of single values.
franck@0:  */
franck@0: 
franck@0: /**
franck@0:  * Central og_statistics api function.
franck@0:  *
franck@0:  * This function is not used yet.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *  The group nid.
franck@0:  *
franck@0:  * @param $key
franck@0:  *   The statistics key, for example members_count.
franck@0:  *
franck@0:  * @param $method
franck@0:  *   How should the value be handled, possible values:
franck@0:  *   - set: Ignore the previos value.
franck@0:  *   - add: add a integer to the previos value.
franck@0:  *
franck@0:  * @param $value
franck@0:  *   The new statistics value.
franck@0:  *
franck@0:  */
franck@0: function og_statistics_update_statistic($gid, $key, $method = 'set', $value) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat[$key] = $method == 'set' ? $value : $stat[$key] + $value;
franck@0:   return drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Implementation of hook_nodeapi().
franck@0:  */
franck@0: function og_statistics_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
franck@0:   switch ($op) {
franck@0:     case 'insert':
franck@0:       // Adds a new record for the new group.
franck@0:       if (og_is_group_type($node->type)) {
franck@0:         og_statistics_write_pure_record($node->nid);
franck@0:       }
franck@0:       // Update statistics.
franck@0:       elseif (og_is_group_post_type($node->type)) {
franck@0:         if (isset($node->og_groups)) {
franck@0:           $node->og_groups = array_unique($node->og_groups);
franck@0:           foreach ($node->og_groups as $gid) {
franck@0:             og_statistics_add_node($gid);
franck@0:             og_statistics_update_last_node($node->created, $gid);
franck@0:           }
franck@0:         }
franck@0:       }
franck@0:       break;
franck@0:     case 'delete':
franck@0:       // Remove a record for group.
franck@0:       if (og_is_group_type($node->type)) {
franck@0:         og_statistics_delete_record($node);
franck@0:       }
franck@0:       // Update statistics.
franck@0:       elseif (og_is_group_post_type($node->type)) {
franck@0:         if (isset($node->og_groups)) {
franck@0:           $node->og_groups = array_unique($node->og_groups);
franck@0:           foreach ($node->og_groups as $gid) {
franck@0:             og_statistics_remove_node($gid);
franck@0:           }
franck@0:         }
franck@0:       }
franck@0:       break;
franck@0:     case 'update':
franck@0:       // Update statistics.
franck@0:       if (og_is_group_post_type($node->type)) {
franck@0:         if (isset($node->og_groups)) {
franck@0:           $updated_gid = array_intersect($node->og_groups, $node->og_initial_groups);
franck@0:           $added_gid = array_diff($node->og_groups, $node->og_initial_groups);
franck@0:           $removed_gid = array_diff($node->og_initial_groups, $node->og_groups);
franck@0:           foreach ($updated_gid as $gid) {
franck@0:             og_statistics_update_last_node($node->changed, $gid);
franck@0:           }
franck@0:           foreach ($added_gid as $gid) {
franck@0:             og_statistics_add_node($gid);
franck@0:             og_statistics_update_last_node($node->changed, $gid);
franck@0:           }
franck@0:           foreach ($removed_gid as $gid) {
franck@0:             og_statistics_remove_node($gid);
franck@0:           }
franck@0:         }
franck@0:       }
franck@0:   }
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Implementation of hook_comment().
franck@0:  */
franck@0: function og_statistics_comment(&$a1, $op) {
franck@0:   switch ($op) {
franck@0:     case 'insert':
franck@0:       $node = node_load($a1['nid']);
franck@0:       if (og_is_group_post_type($node->type)) {
franck@0:         foreach ($node->og_groups as $gid) {
franck@0:           og_statistics_add_comment($gid);
franck@0:           og_statistics_update_last_comment($a1['timestamp'], $gid);
franck@0:         }
franck@0:       }
franck@0:       break;
franck@0:     case 'delete':
franck@0:       $node = node_load($a1->nid);
franck@0:       if (og_is_group_post_type($node->type)) {
franck@0:         foreach ($node->og_groups as $gid) {
franck@0:           og_statistics_remove_comment($gid);
franck@0:         }
franck@0:       }
franck@0:       break;
franck@0:     case 'update':
franck@0:       $node = node_load($a1['nid']);
franck@0:       if (og_is_group_post_type($node->type)) {
franck@0:         foreach ($node->og_groups as $gid) {
franck@0:           og_statistics_update_last_comment($a1['timestamp'], $gid);
franck@0:         }
franck@0:       }
franck@0:       break;
franck@0:   }
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Implementation of hook_og().
franck@0:  */
franck@0: function og_statistics_og($op, $gid, $uid, $args) {
franck@0:   switch ($op) {
franck@0:     case 'user insert':
franck@0:       $time = time();
franck@0:       og_statistics_add_user($gid);
franck@0:       og_statistics_update_last_member($time, $gid);
franck@0:       break;
franck@0:     case 'user delete':
franck@0:       og_statistics_remove_user($gid);
franck@0:       break;
franck@0:   }
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Returns a statistic for a group().
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  *
franck@0:  * @todo
franck@0:  *   Build perhaps a static cache here.
franck@0:  *
franck@0:  */
franck@0: function og_statistics_load($gid) {
franck@0:   $result = db_query("SELECT * FROM {og_statistics} WHERE nid = %d", $gid);
franck@0:   return db_fetch_array($result);
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Writes a record of statistics without any content, but nid.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_write_pure_record($gid) {
franck@0:   // All statistics are set to zero.
franck@0:   $stat = array(
franck@0:     'nid' => $gid,
franck@0:     'members_count' => 0,
franck@0:     'posts_count' => 0,
franck@0:     'comments_count' => 0,
franck@0:     'last_node_timestamp' => 0,
franck@0:     'last_comment_timestamp' => 0,
franck@0:     'last_member_timestamp' => 0,
franck@0:   );
franck@0:   drupal_write_record('og_statistics', $stat);
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Add 1 to posts_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_add_node($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['posts_count']++;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Removes 1 form posts_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_remove_node($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['posts_count']--;
franck@0:   // Load the count of comments and remove this amount of comments.
franck@0:   $node = node_load($gid);
franck@0:   $stat['comments_count'] -= $node->comment_count;
franck@0: 
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Updates the last node of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_update_last_node($timestamp, $gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['last_node_timestamp'] = $timestamp;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Add 1 to comments_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_add_comment($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['comments_count']++;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Removes 1 from comments_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_remove_comment($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['comments_count']--;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Updates the last comment of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_update_last_comment($timestamp, $gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['last_comment_timestamp'] = $timestamp;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Add 1 to members_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_add_user($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['members_count']++;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Removes 1 from members_count of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_remove_user($gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['members_count']--;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Updates the last member of a group.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_update_last_member($timestamp, $gid) {
franck@0:   $stat = og_statistics_load($gid);
franck@0:   $stat['last_member_timestamp'] = $timestamp;
franck@0:   drupal_write_record('og_statistics', $stat, 'nid');
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * Removes a complete record.
franck@0:  *
franck@0:  * @param $gid
franck@0:  *   The group nid.
franck@0:  */
franck@0: function og_statistics_delete_record($gid) {
franck@0:   db_query("DELETE FROM {og_statistics} WHERE nid = %d", $gid);
franck@0: }
franck@0: 
franck@0: /**
franck@0:  * views stuff.
franck@0:  */
franck@0: 
franck@0: /**
franck@0:  * Implementation of hook_views_api().
franck@0:  */
franck@0: function og_statistics_views_api() {
franck@0:   return array(
franck@0:     'api' => 2,
franck@0:   );
franck@0: }
franck@0: