* @author Ralf Becker * @license http://www.gnu.org/copyleft/gpl.html * @link http://www.egroupware.org * @version SVN: $Id$ */ /** * Shows informations about eGroupWare * - general information * - installed applications * - installed templates * - installed languages * * Usage: *


 *  $aboutPage = new about();
 *

* The constuctor will do all * * There is no typical so, bo ui structure, this class is all in one * * @since 1.4 */ class about { /** * constructor of about class * decides to show tab- or detail view * * @since 1.4 */ function about() { // list or detail view $name = 'eGroupWare'; $detail = false; $nonavbar = false; // application detail? if (isset($_GET['app']) && $_GET['app'] != 'eGroupWare') { $name = basename($_GET['app']); $type = 'application'; $detail = true; } // template detail? if (isset($_GET['template']) && $_GET['template'] != 'eGroupWare') { $name = basename($_GET['template']); $type = 'template'; $detail = true; } // navbar or not if (isset($_GET['nonavbar'])) { $nonavbar = $_GET['nonavbar']; } if ($detail) { $this->_detailView($name, $type, $nonavbar); } else { $this->_listView(); } } /** * output of list view * collects data and shows a tabbed view that lists * - general informations * - installed applications * - installed templates * - installed languages * * @return nothing * * @access private * @since 1.4 */ function _listView() { // get informations about the applications $apps = array(); $apps[] = ''; // first empty row for eTemplate foreach (isset($GLOBALS['egw_info']['user']['apps']['admin']) ? $GLOBALS['egw_info']['apps'] : $GLOBALS['egw_info']['user']['apps'] as $app => $appinfo) { $info = $this->_getParsedAppInfo($app); $apps[] = array( 'appImage' => '

', 'appName' => $appinfo['title'], 'appAuthor' => $info['author'], 'appMaintainer' => $info['maintainer'], 'appVersion' => $info['version'], 'appLicense' => $this->_linkLicense($info['license']), 'appDetails' => '

' ); } // get informations about the templates $templates = array(); $templates[] = ''; // first empty row for eTemplate foreach($GLOBALS['egw']->framework->list_templates(true) as $template => $info) { $info = $this->_getParsedTemplateInfo($info); $templates[] = array( 'templateImage' => '

', 'templateName' => $info['title'], 'templateAuthor' => $info['author'], 'templateMaintainer'=> $info['maintainer'], 'templateVersion' => $info['version'], 'templateLicense' => $this->_linkLicense($info['license']), 'templateDetails' => '

' ); } // get informations about installed languages $translations = array(); $translations[] = ''; // first empty row for eTemplate $langs = translation::get_installed_langs(); foreach(translation::get_installed_langs() as $translation => $translationinfo) { $translations[] = array( 'langName' => $translationinfo.' ('.$translation.')' ); } // fill content array for eTemplate $content = array( 'apiVersion' => '

'.lang('eGroupWare API version').' '.$GLOBALS['egw_info']['server']['versions']['phpgwapi'].'

', 'applications' => $apps, 'templates' => $templates, 'translations' => $translations ); $tmpl = new etemplate('phpgwapi.about.index'); $tmpl->exec('phpgwapi.about.index', $content); } /** * output of detail view for applications or templates * * @param string $name application/template name * @param string $type can be 'application' or 'template' :default $type='application' * @param string $nonavbar don't show navbar :default $nonavbar=false * @return nothing * * @access private * @since 1.4 */ function _detailView($name, $type='application', $nonavbar=false) { // get the informations switch ($type) { case 'application': $info = $this->_getParsedAppInfo($name); break; case 'template': $templates = $GLOBALS['egw']->framework->list_templates(true); $info = $this->_getParsedTemplateInfo($templates[$name]); break; } // app names are translated, template names not... if ($type == 'application') { $translatedName = lang($name); } else { $translatedName = $name; } // fill content array $content = array( 'image' => '

', 'name' => '

'.$translatedName.'

', 'description' => '

'.$info['description'].'

', 'note' => $info['note'], 'author' => $info['author'], 'maintainer' => $info['maintainer'], 'version' => $info['version'], 'license' => $this->_linkLicense($info['license']) ); $tmpl =& CreateObject('etemplate.etemplate', 'phpgwapi.about.detail'); if ($nonavbar) { $tmpl->exec('phpgwapi.about.detail', $content, array(), array(), array(), 2); } else { $GLOBALS['egw_info']['flags']['app_header'] = lang('About %1', $translatedName); $tmpl->exec('phpgwapi.about.detail', $content); } } /** * parse template informations from setup.inc.php file * * @param array $info template template info * @return array html formated informations about author(s), * maintainer(s), version, license of the * given application * * @access private * @since 1.4 */ function _getParsedTemplateInfo($info) { // define the return array $info['image'] = file_exists(EGW_SERVER_ROOT.'/'.$info['icon']) ? $GLOBALS['egw_info']['server']['webserver_url'].'/'.$info['icon'] : common::image('thisdoesnotexist',array('navbar','nonav')); $info['author'] = $this->_getHtmlPersonalInfo($info, 'author'); $info['maintainer'] = $this->_getHtmlPersonalInfo($info, 'maintainer'); return $info; } /** * parse application informations from setup.inc.php file * * @param string $app application name * @return array html formated informations about author(s), * maintainer(s), version, license of the * given application * * @access private * @since 1.4 */ function _getParsedAppInfo($app) { // we read all setup files once, as no every app has it's own file static $setup_info; if (is_null($setup_info)) { foreach($GLOBALS['egw_info']['apps'] as $_app => $_data) { if (file_exists($file = EGW_INCLUDE_ROOT.'/'.$_app.'/setup/setup.inc.php')) { include($file); } } } $app_info = $GLOBALS['egw_info']['apps'][$app]; // define the return array $ret = array( 'image' => common::image(isset($app_info['icon_app'])?$app_info['icon_app']:$app, isset($app_info['icon'])?$app_info['icon']:array('navbar','nonav')), 'author' => '', 'maintainer' => '', 'version' => $app_info['version'], 'license' => '', 'description' => '', 'note' => '' ); if (isset($setup_info[$app])) { $ret['author'] = $this->_getHtmlPersonalInfo($setup_info[$app], 'author'); $ret['maintainer'] = $this->_getHtmlPersonalInfo($setup_info[$app], 'maintainer'); if ($app_info['version'] != $setup_info[$app]['version']) $ret['version'] .= ' ('.$setup_info[$app]['version'].')'; $ret['license'] = $setup_info[$app]['license']; $ret['description'] = $setup_info[$app]['description']; $ret['note'] = $setup_info[$app]['note']; } return $ret; } /** * helper to parse author and maintainer info from setup_info array * * @param array $setup_info setup_info[$app] array * ($GLOBALS['egw_info']['template'][$template] array for template informations) * @param string $f 'author' or 'maintainer', default='author' * @return string html formated informations about author/maintainer * * @access private * @since 1.4 */ function _getHtmlPersonalInfo($setup_info, $f = 'author') { $authors = array(); // get the author(s) if ($setup_info[$f]) { // author is set if (!is_array($setup_info[$f])) { // author is no array $authors[0]['name'] = $setup_info[$f]; if ($setup_info[$f.'_email']) { $authors[0]['email'] = $setup_info[$f.'_email']; } if ($setup_info[$f.'_url']) { $authors[0]['url'] = $setup_info[$f.'_url']; } } else { // author is array if ($setup_info[$f]['name']) { // only one author $authors[0]['name'] = $setup_info[$f]['name']; if ($setup_info[$f]['email']) { $authors[0]['email'] = $setup_info[$f]['email']; } if ($setup_info[$f]['url']) { $authors[0]['url'] = $setup_info[$f]['url']; } } else { // may be more authors foreach ($setup_info[$f] as $number => $values) { if ($setup_info[$f][$number]['name']) { $authors[$number]['name'] = $setup_info[$f][$number]['name']; } if ($setup_info[$f][$number]['email']) { $authors[$number]['email'] = $setup_info[$f][$number]['email']; } if ($setup_info[$f][$number]['url']) { $authors[$number]['url'] = $setup_info[$f][$number]['url']; } } } } } // html format authors $s = ''; foreach ($authors as $author) { if ($s != '') { $s .= '
'; } $s .= lang('name').': '.$author['name']; if ($author['email']) { $s .= '
'.lang('email').': '.$author['email'].''; } if ($author['url']) { $s .= '
'.lang('url').': '.$author['url'].''; } } return $s; } /** * surround license string with link to license if it is known * * @param string $license the license to surround with link * @return string linked licence if known, $licence if not known * * @access private * @since 1.4 */ function _linkLicense($license) { // toupper known licenses $knownLicenses = array( 'GPL' => 'http://opensource.org/licenses/gpl-2.0.php', 'LGPL' => 'http://opensource.org/licenses/lgpl-2.1.php', 'GPL3' => 'http://opensource.org/licenses/gpl-3.0.php', 'LGPL3' => 'http://opensource.org/licenses/lgpl-3.0.php', 'PHP' => 'http://opensource.org/licenses/php.php', ); $name = is_array($license) ? $license['name'] : $license; $url = is_array($license) && isset($license['url']) ? $license['url'] : ''; if (!$url && isset($knownLicenses[strtoupper($name)])) { $url = $knownLicenses[$name=strtoupper($name)]; } return !$url ? $name : ''.htmlspecialchars($name).''; } }