* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @package api * @subpackage framework * @access public * @version $Id$ */ /** * EGroupware favorites service-side: * * Favorites are generated on serverside by following code in apps sidebox hook: * * display_sidebox($appname, lang('Favorites'), egw_favorites::favorite_list($appname)); * * Clientside code resides in: * - phpgwapi/js/jsapi/app_base.js * - etemplate/js/et2_widget_favorites.js * * Favorites are stored with prefix "favorite_" in app preferences. */ class egw_favorites { /** * Include favorites when generating the page server-side * * Use this function in your sidebox (or anywhere else, I suppose) to * get the favorite list when a nextmatch is _not_ on the page. If * a nextmatch is on the page, it will update / replace this list. * * @param string $app application, needed to find preferences * @param string $default=null preference name for default favorite, default "nextmatch-$app.index.rows-favorite" * * @return array with a single sidebox menu item (array) containing html for favorites */ public static function list_favorites($app, $default=null) { if(!$app) return ''; if (!$default) $default = "nextmatch-$app.index.rows-favorite"; // This target is used client-side to find & enable adding new favorites $target = 'favorite_sidebox_'.$app; $pref_prefix = 'favorite_'; $filters = array( 'blank' => array( 'name' => lang('No filters'), // Old 'filter' => array(), // New 'state' => array(), 'group' => true ) ) + self::get_favorites($app); $is_admin = $GLOBALS['egw_info']['user']['apps']['admin']; $html = "

\n"; $default_filter = $GLOBALS['egw_info']['user']['preferences'][$app][$default]; if(!isset($default_filter) || !isset($filters[$default_filter])) $default_filter = "blank"; // Get link for if there is no nextmatch - this is the fallback $registry = egw_link::get_registry($app,'list'); if(!$registry) $registry = egw_link::get_registry($app,'index'); foreach($filters as $name => $filter) { $href = "javascript:app.$app.setState(" . json_encode($filter,JSON_FORCE_OBJECT) . ');'; $li = "
• \n"; $li .= ''; $li .= "
  ". $filter['name']; $li .= ($filter['group'] != false && !$is_admin || $name === 'blank' ? "" : "
  "); $li .= "
\n"; //error_log(__METHOD__."() $name, filter=".array2string($filter)." --> ".$li); $html .= $li; } // If were're here, the app supports favorites, so add a 'Add' link too $html .= "
• "; $html .= html::image($app, 'new') . lang('Add current'). '
'; $html .= '

'; return array( array( 'no_lang' => true, 'text' => $html, 'link' => false, 'icon' => false, ), ); } /** * Get a list of actual user favorites * The default 'Blank' favorite is not included here * * @param string $app Current application * * @return array Favorite information */ public static function get_favorites($app) { $favorites = array(); $pref_prefix = 'favorite_'; // Look through all preferences & pull out favorites foreach($GLOBALS['egw_info']['user']['preferences'][$app] as $pref_name => $pref) { if(strpos($pref_name, $pref_prefix) === 0) { if(!is_array($pref)) // old favorite { if (!($pref = unserialize($pref))) continue; $pref = array( 'name' => substr($pref_name,strlen($pref_prefix)), 'group' => !isset($GLOBALS['egw']->preferences->user[$app][$pref_name]), 'state' => $pref, ); //error_log(__METHOD__."() old favorite '$pref_name' converted to ".array2string($pref)); } //else error_log(__METHOD__."() new favorite '$pref_name' ".array2string($pref)); $favorites[(string)substr($pref_name,strlen($pref_prefix))] = $pref; } } return $favorites; } /** * Create or delete a favorite for multiple users * * Current user needs to be an admin or it will just do nothing quietly * * @param string $app Current application, needed to save preference * @param string $name Name of the favorite * @param string $action "add" or "delete" * @param boolean|int|String $group ID of the group to create the favorite for, or 'all' for all users * @param array $filters=array() key => value pairs for the filter * @return boolean Success */ public static function set_favorite($app, $name, $action, $group, $filters = array()) { // Only use alphanumeric for preference name, so it can be used directly as DOM ID $name = strip_tags($name); $pref_name = "favorite_".preg_replace('/[^A-Za-z0-9-_]/','_',$name); // older group-favorites have just true as their group and are not deletable, if we dont find correct group if ($group === true || $group === '1') { if (isset($GLOBALS['egw']->preferences->default[$app][$pref_name])) { $group = 'all'; } else { foreach($GLOBALS['egw']->accounts->memberships($GLOBALS['egw_info']['user']['account_id'], true) as $gid) { $prefs = new preferences($gid); $prefs->read_repository(); if (isset($prefs->user[$app][$pref_name])) { $group = $gid; break; } } } } if($group && $GLOBALS['egw_info']['apps']['admin'] && $group !== 'all') { $prefs = new preferences(is_numeric($group) ? $group : $GLOBALS['egw_info']['user']['account_id']); } else { $prefs = $GLOBALS['egw']->preferences; } $prefs->read_repository(); $type = $group === "all" ? "default" : "user"; //error_log(__METHOD__."('$app', '$name', '$action', ".array2string($group).", ...) pref_name=$pref_name, type=$type"); if($action == "add") { $filters = array( // This is the name as user entered it, minus tags 'name' => $name, 'group' => $group ? $group : false, 'state' => $filters ); $result = $prefs->add($app,$pref_name,$filters,$type); $pref = $prefs->save_repository(false,$type); // Update preferences client side, or it could disappear egw_json_response::get()->call('egw.set_preferences', (array)$pref[$app], $app); egw_json_response::get()->data(isset($result[$app][$pref_name])); return isset($result[$app][$pref_name]); } else if ($action == "delete") { $result = $prefs->delete($app,$pref_name, $type); $pref = $prefs->save_repository(false,$type); // Update preferences client side, or it could come back egw_json_response::get()->call('egw.set_preferences', (array)$pref[$app], $app); egw_json_response::get()->data(!isset($result[$app][$pref_name])); return !isset($result[$app][$pref_name]); } } }