| 1 |
<?php |
| 2 |
// vim: ts=4 foldcolumn=4 foldmethod=marker |
| 3 |
/** |
| 4 |
* Obsessive_Logger class found here. |
| 5 |
* |
| 6 |
* This file is part of Reblog, |
| 7 |
* a derivative work of Feed On Feeds. |
| 8 |
* |
| 9 |
* Distributed under the Gnu Public License. |
| 10 |
* |
| 11 |
* @package Plugins |
| 12 |
* @license http://opensource.org/licenses/gpl-license.php GNU Public License |
| 13 |
* @author Michal Migurski <mike@stamen.com> |
| 14 |
* @author Michael Frumin <mfrumin@eyebeam.org> |
| 15 |
* @copyright ©2004 Michael Frumin, Michal Migurski |
| 16 |
* @link http://reblog.org Reblog |
| 17 |
* @link http://feedonfeeds.com Feed On Feeds |
| 18 |
* @version $Revision: 1.5 $ |
| 19 |
*/ |
| 20 |
|
| 21 |
/** |
| 22 |
* Obsessive_Logger is an example plug-in for refeed. |
| 23 |
* |
| 24 |
* Obsessive_Logger contains |
| 25 |
* handlers for every defined overridable event, and defines simple |
| 26 |
* error_log calls for each one. It can be activated or deactivated by |
| 27 |
* changing the value of {@link Obsessive_Logger::$activePlugin}, and new |
| 28 |
* plugins can be created by duplicating this one and making modifications. |
| 29 |
* |
| 30 |
* @see RF_Controller::loadPlugins() |
| 31 |
* @see RF_Controller::invokePlugin() |
| 32 |
* @package Plugins |
| 33 |
*/ |
| 34 |
class Obsessive_Logger |
| 35 |
{ |
| 36 |
/** |
| 37 |
* This variable must be set to boolean true for thise class to be |
| 38 |
* an active plug-in. |
| 39 |
* |
| 40 |
* @var boolean |
| 41 |
* @see RF_Controller::loadPlugins() |
| 42 |
*/ |
| 43 |
var $activePlugin = false; |
| 44 |
|
| 45 |
/** |
| 46 |
* List of methods available for use via the client-facing API. |
| 47 |
* |
| 48 |
* If a method does not appear in this array, it will not be |
| 49 |
* usable remotely. Methods named here will be lowercased in loadPlugins(). |
| 50 |
* |
| 51 |
* All methods are available internally. |
| 52 |
* |
| 53 |
* @var array |
| 54 |
* @see call.php |
| 55 |
* @see RF_Controller::loadPlugins() |
| 56 |
* @see RF_Controller::invokePlugin() |
| 57 |
*/ |
| 58 |
var $remoteMethods = array(); |
| 59 |
|
| 60 |
/** |
| 61 |
* Reference to operative controller object. |
| 62 |
* @var RF_Controller |
| 63 |
*/ |
| 64 |
var $controller; |
| 65 |
|
| 66 |
/** |
| 67 |
* @var int |
| 68 |
*/ |
| 69 |
var $counter; |
| 70 |
|
| 71 |
/** |
| 72 |
* @param RF_Controller $controller - |
| 73 |
* |
| 74 |
* @uses Obsessive_Logger::$controller Assigned on instantiation, from {@link RF_Controller $controller}. |
| 75 |
* @uses Obsessive_Logger::$counter Set to 0 on instantiation |
| 76 |
*/ |
| 77 |
function Obsessive_Logger(&$controller) |
| 78 |
{ |
| 79 |
$this->controller =& $controller; |
| 80 |
$this->counter =& $counter; |
| 81 |
} |
| 82 |
|
| 83 |
/* |
| 84 |
Start of event handlers. |
| 85 |
These are called throughout Reblog's code, |
| 86 |
via RF_Controller::invokePlugin(). |
| 87 |
|
| 88 |
Your own plug-ins may define some or all of these methods. |
| 89 |
*/ |
| 90 |
|
| 91 |
function loadedPlugins() |
| 92 |
{ |
| 93 |
// called when plugins are first loaded, |
| 94 |
// at the beginning of a request |
| 95 |
error_log("--------------------- Obsessive Logger primed and ready!"); |
| 96 |
error_log(" {$_SERVER['REQUEST_URI']}"); |
| 97 |
} |
| 98 |
|
| 99 |
function finishedRequest() |
| 100 |
{ |
| 101 |
// called when the request is complete, |
| 102 |
// and the page has been sent to the client |
| 103 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: request finished, going to sleep"); |
| 104 |
} |
| 105 |
|
| 106 |
function clientCreated(&$client) |
| 107 |
{ |
| 108 |
// client controller just created |
| 109 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: client controller just ceated"); |
| 110 |
} |
| 111 |
|
| 112 |
function feedDeleted(&$feed) |
| 113 |
{ |
| 114 |
// feed just completely deleted |
| 115 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: feed just deleted ".$feed->getID()); |
| 116 |
} |
| 117 |
|
| 118 |
function unsubscribedUserFromFeed(&$user, &$feed) |
| 119 |
{ |
| 120 |
// user just unsubscribed from a feed |
| 121 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: user ".$user->getID()." just unsubscribed from feed ".$feed->getID()); |
| 122 |
} |
| 123 |
|
| 124 |
function subscribedUserToFeed(&$user, &$feed) |
| 125 |
{ |
| 126 |
// user just subscribed to a feed |
| 127 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: user ".$user->getID()." just subscribed to feed ".$feed->getID()); |
| 128 |
} |
| 129 |
|
| 130 |
function gotFeedUsers(&$feed, &$users) |
| 131 |
{ |
| 132 |
// subscribing users just listed for a feed |
| 133 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got users (".count($users)." users) for feed ".$feed->getID()); |
| 134 |
} |
| 135 |
|
| 136 |
function gotFeedItems(&$feed, &$items) |
| 137 |
{ |
| 138 |
// items just listed for a feed |
| 139 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got items (".count($items)." items) for feed ".$feed->getID()); |
| 140 |
} |
| 141 |
|
| 142 |
function gotFeeds(&$feeds) |
| 143 |
{ |
| 144 |
// all feeds just retrieved |
| 145 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got all feeds (".count($feeds)." feeds)"); |
| 146 |
} |
| 147 |
|
| 148 |
function gotUserItemsQueryArguments(&$args) |
| 149 |
{ |
| 150 |
// user-items query arguments just generated |
| 151 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-items query arguments (".count($args)." args)"); |
| 152 |
} |
| 153 |
|
| 154 |
function gotUserItemsQueryConditions(&$user, &$conditions, &$arguments) |
| 155 |
{ |
| 156 |
// user-items query conditions just generated |
| 157 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-items query conditions (".count($conditions)." conditions) from ".count($arguments)." arguments"); |
| 158 |
} |
| 159 |
|
| 160 |
function gotUserItemsQuery(&$user, &$query) |
| 161 |
{ |
| 162 |
// user-items query just generated |
| 163 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-items query (".strlen($query)." bytes) for user ".$user->getID()); |
| 164 |
} |
| 165 |
|
| 166 |
function gotUserItems(&$user, &$items) |
| 167 |
{ |
| 168 |
// user-items just retrieved |
| 169 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-items (".count($items)." items) for user ".$user->getID()); |
| 170 |
} |
| 171 |
|
| 172 |
function gotUserFeedsQueryArguments(&$args) |
| 173 |
{ |
| 174 |
// user-feeds query arguments just generated |
| 175 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-feeds query arguments (".count($args)." args)"); |
| 176 |
} |
| 177 |
|
| 178 |
function gotUserFeedsQueryConditions(&$user, &$conditions, &$arguments) |
| 179 |
{ |
| 180 |
// user-feeds query conditions just generated |
| 181 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-feeds query conditions (".count($conditions)." conditions) from ".count($arguments)." arguments"); |
| 182 |
} |
| 183 |
|
| 184 |
function gotUserFeedsQuery(&$user, &$query) |
| 185 |
{ |
| 186 |
// user-feeds query just generated |
| 187 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-feeds query (".strlen($query)." bytes) for user ".$user->getID()); |
| 188 |
} |
| 189 |
|
| 190 |
function gotUserFeeds(&$user, &$feeds) |
| 191 |
{ |
| 192 |
// user-feeds just retrieved |
| 193 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got user-feeds (".count($feeds)." feeds) for user ".$user->getID()); |
| 194 |
} |
| 195 |
|
| 196 |
function gotUserSelfFeedQuery(&$user, &$query) |
| 197 |
{ |
| 198 |
// user-self-feeds query just generated |
| 199 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got self-feed query (".strlen($query)." bytes) for user ".$user->getID()); |
| 200 |
} |
| 201 |
|
| 202 |
function gotUserSelfFeed(&$user, &$feed) |
| 203 |
{ |
| 204 |
// user-self-feed just pulled from database into object form |
| 205 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got self-feed for user ".$user->getID()); |
| 206 |
} |
| 207 |
|
| 208 |
function gotUserTags(&$user, $referent, &$tags) |
| 209 |
{ |
| 210 |
// tags just listed for a user |
| 211 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: got {$referent} tags (".count($tags)." tags) for user ".$user->getID()); |
| 212 |
} |
| 213 |
|
| 214 |
function freshenedUserFeedItems(&$user, &$feed, &$items) |
| 215 |
{ |
| 216 |
// new or modified items just freshened |
| 217 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: freshened item (".count($items)." items) in feed ".$feed->getID()." for user ".$user->getID()); |
| 218 |
} |
| 219 |
|
| 220 |
function flushedObsoleteUserItems(&$user, &$feed, &$items) |
| 221 |
{ |
| 222 |
// one user's obsolete items have been flushed out |
| 223 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: flushed ".count($items)." items from feed ".$feed->getID()." for user ".$user->getID()); |
| 224 |
} |
| 225 |
|
| 226 |
function flushedObsoleteItems(&$feed, &$items) |
| 227 |
{ |
| 228 |
// obsolete items have been flushed out completely |
| 229 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: flushed ".count($items)." items from feed ".$feed->getID()); |
| 230 |
} |
| 231 |
|
| 232 |
function savedNewFeed(&$feed) |
| 233 |
{ |
| 234 |
// new feed has just been saved |
| 235 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just saved new feed ".$feed->getID()); |
| 236 |
} |
| 237 |
|
| 238 |
function savedExistingFeed(&$feed) |
| 239 |
{ |
| 240 |
// existing feed has just been saved |
| 241 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just saved existing feed ".$feed->getID()); |
| 242 |
} |
| 243 |
|
| 244 |
function updatedFeed(&$feed) |
| 245 |
{ |
| 246 |
// feed has just been updated |
| 247 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just updated feed ".$feed->getID()); |
| 248 |
} |
| 249 |
|
| 250 |
function preparedItemArguments(&$feed, &$prepared_args, &$rss_data) |
| 251 |
{ |
| 252 |
// item arguments from incoming feed may need to be scrubbed or something |
| 253 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just prepared item arguments in feed ".$feed->getID()." (".join(', ', array_keys($prepared_args)).")"); |
| 254 |
} |
| 255 |
|
| 256 |
function saveModifiedItemBefore(&$item) |
| 257 |
{ |
| 258 |
// previously-existing, modified item about to be saved |
| 259 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: about to save modified item ".$item->getID()); |
| 260 |
} |
| 261 |
|
| 262 |
function savedModifiedItem(&$item) |
| 263 |
{ |
| 264 |
// previously-existing, modified item has just been saved |
| 265 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just saved modified item ".$item->getID()); |
| 266 |
} |
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
function saveNewItemBefore(&$item) |
| 271 |
{ |
| 272 |
// new item about to be saved |
| 273 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: about to save new item ".$item->getID()); |
| 274 |
} |
| 275 |
|
| 276 |
function savedNewItem(&$item) |
| 277 |
{ |
| 278 |
// new item has just been saved |
| 279 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just saved new item ".$item->getID()); |
| 280 |
} |
| 281 |
|
| 282 |
function setItemCommentTags(&$user, &$item, &$comment, &$tags) |
| 283 |
{ |
| 284 |
// comment & tags just assigned to an item |
| 285 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set comment (".strlen($comment)." bytes) and tags (".count($tags)." tags) for user ".$user->getID()." item ".$item->getID()); |
| 286 |
} |
| 287 |
|
| 288 |
function setItemTags(&$user, &$item, &$tags) |
| 289 |
{ |
| 290 |
// tags just assigned to an item |
| 291 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set tags (".count($tags)." tags) for user ".$user->getID()." item ".$item->getID()); |
| 292 |
} |
| 293 |
|
| 294 |
function setFeedTags(&$user, &$feed, &$tags) |
| 295 |
{ |
| 296 |
// tags just assigned to a feed |
| 297 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set tags (".count($tags)." tags) for user ".$user->getID()." feed ".$feed->getID()); |
| 298 |
} |
| 299 |
|
| 300 |
function setItemTitleContentLink(&$user, &$item, &$title, &$content, &$link) |
| 301 |
{ |
| 302 |
// title, link & content just assigned to an item |
| 303 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set title (".strlen($title)." bytes), link (".strlen($link)." bytes), and content (".strlen($content)." bytes) for user ".$user->getID()." item ".$item->getID()); |
| 304 |
} |
| 305 |
|
| 306 |
function setItemLink(&$user, &$item, &$link) |
| 307 |
{ |
| 308 |
// link just assigned to an item |
| 309 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set link to {$link} for user ".$user->getID()." item ".$item->getID()); |
| 310 |
} |
| 311 |
|
| 312 |
function markedItemRead(&$user, &$item) |
| 313 |
{ |
| 314 |
// user-item just marked read |
| 315 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked item ".$item->getID()." read for user ".$user->getID()); |
| 316 |
} |
| 317 |
|
| 318 |
function markedItemsRead(&$user, &$items) |
| 319 |
{ |
| 320 |
// list of user-items just marked read |
| 321 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked ".count($items)." items read for user ".$user->getID()); |
| 322 |
} |
| 323 |
|
| 324 |
function markedItemUnread(&$user, &$item) |
| 325 |
{ |
| 326 |
// user-item just marked unread |
| 327 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked item ".$item->getID()." unread for user ".$user->getID()); |
| 328 |
} |
| 329 |
|
| 330 |
function markedItemsUnread(&$user, &$items) |
| 331 |
{ |
| 332 |
// list of user-items just marked unread |
| 333 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked ".count($items)." items unread for user ".$user->getID()); |
| 334 |
} |
| 335 |
|
| 336 |
function markedItemPublished(&$user, &$item) |
| 337 |
{ |
| 338 |
// user-item just marked published |
| 339 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked item ".$item->getID()." published for user ".$user->getID()); |
| 340 |
} |
| 341 |
|
| 342 |
function markedItemsPublished(&$user, &$items) |
| 343 |
{ |
| 344 |
// list of user-items just marked published |
| 345 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked ".count($items)." items published for user ".$user->getID()); |
| 346 |
} |
| 347 |
|
| 348 |
function markedItemUnpublished(&$user, &$item) |
| 349 |
{ |
| 350 |
// user-item just marked unpublished |
| 351 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked item ".$item->getID()." unpublished for user ".$user->getID()); |
| 352 |
} |
| 353 |
|
| 354 |
function markedItemsUnpublished(&$user, &$items) |
| 355 |
{ |
| 356 |
// list of user-items just marked unpublished |
| 357 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked ".count($items)." items unpublished for user ".$user->getID()); |
| 358 |
} |
| 359 |
|
| 360 |
function markedFeedPublished(&$user, &$feed) |
| 361 |
{ |
| 362 |
// user-feed just marked published |
| 363 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked feed ".$feed->getID()." published for user ".$user->getID()); |
| 364 |
} |
| 365 |
|
| 366 |
function markedFeedUnpublished(&$user, &$feed) |
| 367 |
{ |
| 368 |
// user-feed just marked unpublished |
| 369 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just marked feed ".$feed->getID()." unpublished for user ".$user->getID()); |
| 370 |
} |
| 371 |
|
| 372 |
function postedItem(&$user, &$item) |
| 373 |
{ |
| 374 |
// new item just inserted |
| 375 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just inserted item ".$item->getID()." into user ".$user->getID()."'s self-feed"); |
| 376 |
} |
| 377 |
|
| 378 |
function setKeyboardUse(&$user, &$use) |
| 379 |
{ |
| 380 |
// just flipped keyboard usage |
| 381 |
error_log(sprintf('%3d ', ++$this->counter)."Obsessive Logger: just set keyboard usage to {$use} for user ".$user->getID()); |
| 382 |
} |
| 383 |
} |
| 384 |
|
| 385 |
?> |
Parent Directory
| 
Revision Log