river/lib.php

   1 <?php
   2         /*
   3          Event log and river plugin for Elgg
   4          Initial author: Marcus Povey <marcus@dushka.co.uk>
   5
   6          Notes:
   7          This is a little rough and ready. If you want to add events to the river you need to register
   8          a handle and listen to various publish / delete /create events applicable to your module.
   9
  10          For compatibility I would suggest that you place the listen_for_event calls inside a function exists
  11          test. This will allow handle the situation where the river plugin is not present.
  12
  13          eg.
  14
  15          if (function_exists('river_save_event'))
  16          {
  17                 listen_for_event('file','publish', 'file_river_hook');
  18                 listen_for_event('file','delete', 'file_river_hook');
  19          }
  20         */
  21
  22         function river_init()
  23         {
  24                 global $CFG, $db, $template;
  25
  26                 // Set up the database
  27                 $tables = $db->Metatables();
  28                 if (!in_array($CFG->prefix . "river", $tables))
  29                 {
  30                         if (file_exists($CFG->dirroot . "mod/river/$CFG->dbtype.sql"))
  31                         {
  32                                 modify_database($CFG->dirroot . "mod/river/$CFG->dbtype.sql");
  33                         }
  34                         else
  35                         {
  36                                 error("Error: Your database ($CFG->dbtype) is not yet fully supported by the Elgg river.  See the mod/river directory.");
  37                         }
  38
  39                         print_continue("index.php");
  40                         exit;
  41                 }
  42
  43                 // Test for widget support
  44                 if (!function_exists('widget_init'))
  45                 {
  46                         error("Widget support isn't installed. Please download and install the widgets module to mod/widget.");
  47                         exit;
  48                 }
  49
  50                 // Register widget
  51                 $CFG->widgets->list[] = array(
  52                         'name' => gettext("River widget"),
  53                         'description' => gettext("Display a list of recent activity."),
  54                         'type' => "river::river"
  55                 );
  56
  57                 $template['css'] .= file_get_contents($CFG->dirroot . "mod/river/css.css");
  58
  59         }
  60
  61         function river_pagesetup()
  62         {
  63         }
  64
  65         /** Save a river event to the database */
  66         function river_save_event($userid, $object_id, $object_owner, $object_type, $string, $access = "PUBLIC")
  67         {
  68                 $entry = new stdClass;
  69                         $entry->userid = $userid;
  70                         $entry->object_id = $object_id;
  71                         $entry->object_owner = $object_owner;
  72                         $entry->object_type = $object_type;
  73                         $entry->access = $access;
  74                         $entry->ts = time();
  75                         $entry->string = $string;
  76
  77                 return insert_record('river', $entry);
  78         }
  79
  80         /** Get the display data */
  81         function river_get_river($userid, $limit = 10, $starttime = "", $endtime = "")
  82         {
  83                 global $CFG;
  84
  85                 // Get mutual friend network
  86
  87                         // My friends
  88                         $query = "SELECT friend from {$CFG->prefix}friends where owner=$userid";
  89 //echo "$query\n";
  90                         $myfriends = get_records_sql($query);
  91
  92                         $list = "";
  93                         foreach ($myfriends as $friend)
  94                                 $list .= $friend->friend . ",";
  95                         $list = trim($list, " ,");
  96
  97                         // Get a subset who also have me as a friend
  98                         $query = "SELECT owner from {$CFG->prefix}friends where owner in ($list) and friend=$userid";
  99 //echo "$query\n";
 100                         $theirfriends = get_records_sql($query);
 101
 102                         $list2 = "";
 103                         foreach ($theirfriends as $friend)
 104                                 $list2 .= $friend->owner . ",";
 105
 106                         $list = "$list2";
 107
 108                         $list2 = trim($list2, " ,");
 109                         $list .= $userid; // We also want to include myself ( to the first list not the second).
 110
 111                         if ($list2=="") return false;
 112
 113                         // Time range
 114                         if ($starttime!="")
 115                                 $starttime = "and ts >= $starttime";
 116
 117                         if ($endtime!="")
 118                                 $endtime = "and ts <= $endtime";
 119
 120                         // Fix limit
 121                         if ($limit == 0)
 122                                 $limit = "";
 123                         else
 124                                 $limit = "limit $limit";
 125
 126                         // Do access
 127                         $access = " and (access='PUBLIC' ";
 128                         if (isloggedin()) $access .= " or access='LOGGED_IN' ";
 129                         if ($userid == $_SESSION['userid'])  $access .= " or access='PRIVATE' ";
 130                         $access .= ") ";
 131
 132                         $query = "select * from {$CFG->prefix}river where 1 $starttime $endtime $access and (userid in ($list) or object_owner in ($list2))  order by ts desc $limit";
 133 //echo "$query\n";
 134                         return get_records_sql($query);
 135
 136         }
 137
 138         /** Display the widget */
 139         function river_widget_display($widget)
 140         {
 141                 global $CFG;
 142
 143                 // Pull number of river entries
 144                 $river_num_display = widget_get_data("river_num_display",$widget->ident);
 145                 if ($river_num_display == "") $river_num_display = 10;
 146
 147                 $userid = page_owner(); // user id is page owner
 148                 $name = user_info("name", $userid);
 149
 150                 $river = river_get_river($userid, $river_num_display);
 151
 152                 $body = "";
 153                 if ($river)
 154                 {
 155                         $d1 = "";
 156                         $d2 = "";
 157
 158                         foreach ($river as $r)
 159                         {
 160                                 $d2 = date("j-n-y", $r->ts); // Set second marker
 161
 162                                 $type = str_replace(":", "_", $r->object_type);
 163
 164                                 if (strcmp($d1,$d2)!=0) $body .= "<p class=\"widget_river_date\">". date("l jS F Y", $r->ts) . "</p>";
 165                                 $body .= "<div class=\"widget_river_type_$type\"><div class=\"widget_river_text\"> " . __gettext($r->string) . "<span class=\"widget_river_time\">" . date("g:ia", $r->ts) . "</span></div></div>";
 166
 167                                 $d1 = date("j-n-y", $r->ts); // Now set first marker to date
 168                         }
 169
 170                         $body .= "<div class=\"widget_river_rss\"><a href=\"{$CFG->wwwroot}mod/river/rss.php?owner=$userid\"><img src=\"{$CFG->wwwroot}mod/template/icons/rss.png\" border=\"0\" /></a></div>";
 171                 }
 172                 else
 173                 {
 174                         $body = __gettext("This user hasn't done anything yet.");
 175                 }
 176
 177                 //$ttl = "<table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\"><tr><td align=\"left\">".  $name . __gettext("'s River") . "</td><td align=\"right\"><a href=\"{$CFG->wwwroot}mod/river/rss.php?owner=" . page_owner() . "\"><img src=\"{$CFG->wwwroot}mod/template/icons/rss.png\" border=\"0\" /></a></td></tr></table>";
 178
 179                 return array('title'=> $name . __gettext("'s River"),'content'=>$body);
 180                 //return array('title'=> $ttl,'content'=>$body);
 181         }
 182
 183         /** Edit the widget */
 184         function river_widget_edit($widget)
 185         {
 186                 global $CFG;
 187
 188                 $num_display = widget_get_data("river_num_display", $widget->ident);
 189                 if (!$num_display) $num_display = 10;
 190
 191                 $body = "<h2>". __gettext("River Widget") . "</h2>";
 192                 $body .= "<p>" . __gettext("This widget displays a river of events to do with a user.") . "</p>";
 193
 194                 $body .= "<p><select name=\"widget_data[river_num_display]\">\n";
 195                 for ($n = 5; $n <50; $n += 5)
 196                 {
 197                         if ($n == $num_display) {
 198                                 $selected= "selected=\"selected\"";
 199                         } else {
 200                                 $selected= "";
 201                         }
 202
 203                         $body .= "<option value=\"" . $n . "\" $selected>" . $n. "</option>\n";
 204                 }
 205
 206                 $body .= "</select></p>\n";
 207
 208                 // Return HTML
 209                 return $body;
 210         }
 211
 212         /** Register a hook to return the friendly name of an object */
 213         function river_register_friendlyname_hook($object_type, $function)
 214         {
 215                 global $CFG;
 216
 217                 if (!isset($CFG->river_friendlyname_hooks))
 218                         $CFG->river_friendlyname_hooks = array();
 219
 220                 $CFG->river_friendlyname_hooks[$object_type][] = $function;
 221         }
 222
 223         /** Look through registed hooks for something that will return a friendly string identifying $object_id of type $object_type */
 224         function river_get_friendly_id($object_type, $object_id)
 225         {
 226                 global $CFG;
 227
 228                 $fn = "";
 229
 230                 if (isset($CFG->river_friendlyname_hooks[$object_type]))
 231                 {
 232                         foreach ($CFG->river_friendlyname_hooks[$object_type] as $function)
 233                         {
 234                                 if (is_callable($function))
 235                                         $fn = $function( $object_type, $object_id);
 236                         }
 237
 238                         if ($fn=="")
 239                                 $fn = $object_type . " " . $object_id;
 240                 }
 241
 242                 return $fn;
 243         }
 244
 245         /** Simple function to get the URL of a user from their userid */
 246         function river_get_userurl($userid)
 247         {
 248                 global $CFG;
 249
 250                 return $CFG->wwwroot . user_info("username", $userid) . "/";
 251         }
 252
 253 /* FUture notes:
 254  - collections on river so that you can filter them
 255 */
 256
 257 ?>