diff options
author | Brion Vibber <brion@pobox.com> | 2010-09-30 14:46:32 -0700 |
---|---|---|
committer | Brion Vibber <brion@pobox.com> | 2010-09-30 18:05:44 -0700 |
commit | cb449682e3c0d4aa3b735f203836ce03330740a0 (patch) | |
tree | 1d33cbbd7ad5f14f94862e3cf4ed182ae1bc59d1 /plugins/SlicedFavorites | |
parent | 84fba0271de3aa32be9e0444e647a063d4f5062e (diff) |
Initial SlicedFavorites plugin to allow for customized variants of 'Popular' tab (favorited action) that include or exclude a given set of users. No added UI tabs in this version, beware!
Diffstat (limited to 'plugins/SlicedFavorites')
-rw-r--r-- | plugins/SlicedFavorites/SlicedFavoritesPlugin.php | 109 | ||||
-rw-r--r-- | plugins/SlicedFavorites/favoritedsliceaction.php | 155 |
2 files changed, 264 insertions, 0 deletions
diff --git a/plugins/SlicedFavorites/SlicedFavoritesPlugin.php b/plugins/SlicedFavorites/SlicedFavoritesPlugin.php new file mode 100644 index 000000000..0a1a591ef --- /dev/null +++ b/plugins/SlicedFavorites/SlicedFavoritesPlugin.php @@ -0,0 +1,109 @@ +<?php +/* + * StatusNet - the distributed open-source microblogging tool + * Copyright (C) 2010, StatusNet, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +/** + * @package YammerImportPlugin + * @maintainer Brion Vibber <brion@status.net> + */ + +if (!defined('STATUSNET')) { exit(1); } + +class SlicedFavoritesPlugin extends Plugin +{ + /** + * Example: + * + * addPlugin('SlicedFavorites', array( + * 'slices' => array( + * // show only pop's notices on /favorited + * 'default' => array('include' => array('pop')), + * + * // show only son's notices on /favorited/blog + * 'blog' => array('include' => array('son')), + * + * // show all favorited notices except pop's and son's on /favorited/submitted + * 'submitted' => array('exclude' => array('pop', 'son')), + * + * // show all favorited notices on /favorited/everybody + * 'everybody' => array(), + * ) + * )); + * + * @var array + */ + public $slices = array(); + + /** + * Hook for RouterInitialized event. + * + * @param Net_URL_Mapper $m path-to-action mapper + * @return boolean hook return + */ + function onRouterInitialized($m) + { + $m->connect('favorited/:slice', + array('action' => 'favoritedslice'), + array('slice' => '[a-zA-Z0-9]+')); + + return true; + } + + // Take over the default... :D + function onArgsInitialize($args) + { + if (array_key_exists('action', $args)) { + $action = trim($args['action']); + if ($action == 'favorited') { + common_redirect(common_local_url('favoritedslice', array('slice' => 'default'))); + exit(0); + } + } + return true; + } + + /** + * Automatically load the actions and libraries used by the plugin + * + * @param Class $cls the class + * + * @return boolean hook return + * + */ + function onAutoload($cls) + { + $base = dirname(__FILE__); + $lower = strtolower($cls); + switch ($lower) { + case 'favoritedsliceaction': + require_once "$base/$lower.php"; + return false; + default: + return true; + } + } + + function onSlicedFavoritesGetSettings($slice, &$data) + { + if (isset($this->slices[$slice])) { + $data = $this->slices[$slice]; + return false; + } + return true; + } +} diff --git a/plugins/SlicedFavorites/favoritedsliceaction.php b/plugins/SlicedFavorites/favoritedsliceaction.php new file mode 100644 index 000000000..020688cfa --- /dev/null +++ b/plugins/SlicedFavorites/favoritedsliceaction.php @@ -0,0 +1,155 @@ +<?php +/** + * StatusNet, the distributed open-source microblogging tool + * + * List of popular notices + * + * PHP version 5 + * + * LICENCE: This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + * @category Public + * @package StatusNet + * @author Zach Copley <zach@status.net> + * @author Evan Prodromou <evan@status.net> + * @copyright 2008-2009 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://status.net/ + */ + +if (!defined('STATUSNET') && !defined('LACONICA')) { + exit(1); +} + + +class FavoritedSliceAction extends FavoritedAction +{ + private $includeUsers = array(), $excludeUsers = array(); + + /** + * Take arguments for running + * + * @param array $args $_REQUEST args + * + * @return boolean success flag + * + * @todo move queries from showContent() to here + */ + + function prepare($args) + { + parent::prepare($args); + + $this->slice = $this->arg('slice', 'default'); + $data = array(); + if (Event::handle('SlicedFavoritesGetSettings', array($this->slice, &$data))) { + throw new ClientException(_m('Unknown favorites slice.')); + } + if (isset($data['include'])) { + $this->includeUsers = $data['include']; + } + if (isset($data['exclude'])) { + $this->excludeUsers = $data['exclude']; + } + + return true; + } + + /** + * Content area + * + * Shows the list of popular notices + * + * @return void + */ + + function showContent() + { + $slice = $this->sliceWhereClause(); + if (!$slice) { + return parent::showContent(); + } + + $weightexpr = common_sql_weight('fave.modified', common_config('popular', 'dropoff')); + $cutoff = sprintf("fave.modified > '%s'", + common_sql_date(time() - common_config('popular', 'cutoff'))); + + $qry = 'SELECT notice.*, '. + $weightexpr . ' as weight ' . + 'FROM notice JOIN fave ON notice.id = fave.notice_id ' . + "WHERE $cutoff AND $slice " . + 'GROUP BY id,profile_id,uri,content,rendered,url,created,notice.modified,reply_to,is_local,source,notice.conversation ' . + 'ORDER BY weight DESC'; + + $offset = ($this->page - 1) * NOTICES_PER_PAGE; + $limit = NOTICES_PER_PAGE + 1; + + if (common_config('db', 'type') == 'pgsql') { + $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset; + } else { + $qry .= ' LIMIT ' . $offset . ', ' . $limit; + } + + $notice = Memcached_DataObject::cachedQuery('Notice', + $qry, + 600); + + $nl = new NoticeList($notice, $this); + + $cnt = $nl->show(); + + if ($cnt == 0) { + $this->showEmptyList(); + } + + $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE, + $this->page, 'favorited'); + } + + private function sliceWhereClause() + { + $include = $this->nicknamesToIds($this->includeUsers); + $exclude = $this->nicknamesToIds($this->excludeUsers); + + if (count($include) == 1) { + return "profile_id = " . intval($include[0]); + } else if (count($include) > 1) { + return "profile_id IN (" . implode(',', $include) . ")"; + } else if (count($exclude) == 1) { + return "profile_id != " . intval($exclude[0]); + } else if (count($exclude) > 1) { + return "profile_id NOT IN (" . implode(',', $exclude) . ")"; + } else { + return false; + } + } + + /** + * + * @param array $nicks array of user nicknames + * @return array of profile/user IDs + */ + private function nicknamesToIds($nicks) + { + $ids = array(); + foreach ($nicks as $nick) { + // not the most efficient way for a big list! + $user = User::staticGet('nickname', $nick); + if ($user) { + $ids[] = intval($user->id); + } + } + return $ids; + } +} |