core = $modules->core;
$this->modules = $modules;
$this->store = new dcStore($modules, $xml_url);
$this->setPath($modules_root);
$this->setIndex(__('other'));
}
/**
* Begin a new list.
*
* @param string $id New list ID
* @return adminModulesList self instance
*/
public function setList($id)
{
$this->data = array();
$this->page_tab = '';
$this->list_id = $id;
return $this;
}
/**
* Get list ID.
*
* @return List ID
*/
public function getList()
{
return $this->list_id;
}
/// @name Modules root directory methods
//@{
/**
* Set path info.
*
* @param string $root Modules root directories
* @return adminModulesList self instance
*/
protected function setPath($root)
{
$paths = explode(PATH_SEPARATOR, $root);
$path = array_pop($paths);
unset($paths);
$this->path = $path;
if (is_dir($path) && is_writeable($path)) {
$this->path_writable = true;
$this->path_pattern = preg_quote($path,'!');
}
return $this;
}
/**
* Get modules root directory.
*
* @return Path to work on
*/
public function getPath()
{
return $this->path;
}
/**
* Check if modules root directory is writable.
*
* @return True if directory is writable
*/
public function isWritablePath()
{
return $this->path_writable;
}
/**
* Check if root directory of a module is deletable.
*
* @param string $root Module root directory
* @return True if directory is delatable
*/
public function isDeletablePath($root)
{
return $this->path_writable
&& (preg_match('!^'.$this->path_pattern.'!', $root) || defined('DC_DEV') && DC_DEV)
&& $this->core->auth->isSuperAdmin();
}
//@}
/// @name Page methods
//@{
/**
* Set page base URL.
*
* @param string $url Page base URL
* @return adminModulesList self instance
*/
public function setURL($url)
{
$this->page_qs = strpos('?', $url) ? '&' : '?';
$this->page_url = $url;
return $this;
}
/**
* Get page URL.
*
* @param string|array $queries Additionnal query string
* @param booleany $with_tab Add current tab to URL end
* @return Clean page URL
*/
public function getURL($queries='', $with_tab=true)
{
return $this->page_url.
(!empty($queries) ? $this->page_qs : '').
(is_array($queries) ? http_build_query($queries) : $queries).
($with_tab && !empty($this->page_tab) ? '#'.$this->page_tab : '');
}
/**
* Set page tab.
*
* @param string $tab Page tab
* @return adminModulesList self instance
*/
public function setTab($tab)
{
$this->page_tab = $tab;
return $this;
}
/**
* Get page tab.
*
* @return Page tab
*/
public function getTab()
{
return $this->page_tab;
}
/**
* Set page redirection.
*
* @param string $default Default redirection
* @return adminModulesList self instance
*/
public function setRedir($default='')
{
$this->page_redir = empty($_REQUEST['redir']) ? $default : $_REQUEST['redir'];
return $this;
}
/**
* Get page redirection.
*
* @return Page redirection
*/
public function getRedir()
{
return empty($this->page_redir) ? $this->getURL() : $this->page_redir;
}
//@}
/// @name Search methods
//@{
/**
* Get search query.
*
* @return Search query
*/
public function getSearch()
{
$query = !empty($_REQUEST['m_search']) ? trim($_REQUEST['m_search']) : null;
return strlen($query) > 2 ? $query : null;
}
/**
* Display searh form.
*
* @return adminModulesList self instance
*/
public function displaySearch()
{
$query = $this->getSearch();
if (empty($this->data) && $query === null) {
return $this;
}
echo
'';
if ($query) {
echo
''.sprintf(
__('Found %d result for search "%s":', 'Found %d results for search "%s":', count($this->data)),
count($this->data), html::escapeHTML($query)
).
'
';
}
return $this;
}
//@}
/// @name Navigation menu methods
//@{
/**
* Set navigation special index.
*
* @return adminModulesList self instance
*/
public function setIndex($str)
{
$this->nav_special = (string) $str;
$this->nav_list = array_merge(str_split(self::$nav_indexes), array($this->nav_special));
return $this;
}
/**
* Get index from query.
*
* @return Query index or default one
*/
public function getIndex()
{
return isset($_REQUEST['m_nav']) && in_array($_REQUEST['m_nav'], $this->nav_list) ? $_REQUEST['m_nav'] : $this->nav_list[0];
}
/**
* Display navigation by index menu.
*
* @return adminModulesList self instance
*/
public function displayIndex()
{
if (empty($this->data) || $this->getSearch() !== null) {
return $this;
}
# Fetch modules required field
$indexes = array();
foreach ($this->data as $id => $module) {
if (!isset($module[$this->sort_field])) {
continue;
}
$char = substr($module[$this->sort_field], 0, 1);
if (!in_array($char, $this->nav_list)) {
$char = $this->nav_special;
}
if (!isset($indexes[$char])) {
$indexes[$char] = 0;
}
$indexes[$char]++;
}
$buttons = array();
foreach($this->nav_list as $char) {
# Selected letter
if ($this->getIndex() == $char) {
$buttons[] = ' '.$char.' '.$char.' '.$char.' ';
}
}
# Parse navigation menu
echo '';
return $this;
}
//@}
/// @name Sort methods
//@{
/**
* Set default sort field.
*
* @return adminModulesList self instance
*/
public function setSort($field, $asc=true)
{
$this->sort_field = $field;
$this->sort_asc = (boolean) $asc;
return $this;
}
/**
* Get sort field from query.
*
* @return Query sort field or default one
*/
public function getSort()
{
return !empty($_REQUEST['m_sort']) ? $_REQUEST['m_sort'] : $this->sort_field;
}
/**
* Display sort field form.
*
* @note This method is not implemented yet
* @return adminModulesList self instance
*/
public function displaySort()
{
//
return $this;
}
//@}
/// @name Modules methods
//@{
/**
* Set modules and sanitize them.
*
* @return adminModulesList self instance
*/
public function setModules($modules)
{
$this->data = array();
if (!empty($modules) && is_array($modules)) {
foreach($modules as $id => $module) {
$this->data[$id] = self::sanitizeModule($id, $module);
}
}
return $this;
}
/**
* Get modules currently set.
*
* @return Array of modules
*/
public function getModules()
{
return $this->data;
}
/**
* Sanitize a module.
*
* This clean infos of a module by adding default keys
* and clean some of them, sanitize module can safely
* be used in lists.
*
* @return Array of the module informations
*/
public static function sanitizeModule($id, $module)
{
$label = empty($module['label']) ? $id : $module['label'];
$name = __(empty($module['name']) ? $label : $module['name']);
return array_merge(
# Default values
array(
'desc' => '',
'author' => '',
'version' => 0,
'current_version' => 0,
'root' => '',
'root_writable' => false,
'permissions' => null,
'parent' => null,
'priority' => 1000,
'standalone_config' => false,
'support' => '',
'section' => '',
'tags' => '',
'details' => '',
'sshot' => '',
'score' => 0
),
# Module's values
$module,
# Clean up values
array(
'id' => $id,
'sid' => self::sanitizeString($id),
'label' => $label,
'name' => $name,
'sname' => self::sanitizeString($name)
)
);
}
/**
* Check if a module is part of the distribution.
*
* @param string $id Module root directory
* @return True if module is part of the distribution
*/
public static function isDistributedModule($id)
{
$distributed_modules = self::$distributed_modules;
return is_array($distributed_modules) && in_array($id, $distributed_modules);
}
/**
* Sort modules list by specific field.
*
* @param string $module Array of modules
* @param string $field Field to sort from
* @param bollean $asc Sort asc if true, else decs
* @return Array of sorted modules
*/
public static function sortModules($modules, $field, $asc=true)
{
$sorter = array();
foreach($modules as $id => $module) {
$sorter[$id] = isset($module[$field]) ? $module[$field] : $field;
}
array_multisort($sorter, $asc ? SORT_ASC : SORT_DESC, $modules);
return $modules;
}
/**
* Display list of modules.
*
* @param array $cols List of colones (module field) to display
* @param array $actions List of predefined actions to show on form
* @param boolean $nav_limit Limit list to previously selected index
* @return adminModulesList self instance
*/
public function displayModules($cols=array('name', 'version', 'desc'), $actions=array(), $nav_limit=false)
{
echo
''.
'
'.
''.html::escapeHTML(__('Modules list')).' ';
if (in_array('name', $cols)) {
echo
''.__('Name').' ';
}
if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
echo
''.__('Score').' ';
}
if (in_array('version', $cols)) {
echo
''.__('Version').' ';
}
if (in_array('current_version', $cols)) {
echo
''.__('Current version').' ';
}
if (in_array('desc', $cols)) {
echo
''.__('Details').' ';
}
if (in_array('distrib', $cols)) {
echo '';
}
if (!empty($actions) && $this->core->auth->isSuperAdmin()) {
echo
''.__('Action').' ';
}
echo
' ';
$sort_field = $this->getSort();
# Sort modules by $sort_field (default sname)
$modules = $this->getSearch() === null ?
self::sortModules($this->data, $sort_field, $this->sort_asc) :
$this->data;
$count = 0;
foreach ($modules as $id => $module)
{
# Show only requested modules
if ($nav_limit && $this->getSearch() === null) {
$char = substr($module[$sort_field], 0, 1);
if (!in_array($char, $this->nav_list)) {
$char = $this->nav_special;
}
if ($this->getIndex() != $char) {
continue;
}
}
echo
'';
if (in_array('icon', $cols)) {
echo
''.sprintf(
' ';
}
# Link to config file
$config = in_array('config', $cols) && !empty($module['root']) && file_exists(path::real($module['root'].'/_config.php'));
echo
''.($config ?
''.html::escapeHTML($module['name']).' ' :
html::escapeHTML($module['name'])
).' ';
# Display score only for debug purpose
if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
echo
''.$module['score'].' '.html::escapeHTML($module['version']).' ';
}
if (in_array('current_version', $cols)) {
echo
''.html::escapeHTML($module['current_version']).' ';
}
if (in_array('desc', $cols)) {
echo
''.html::escapeHTML($module['desc']).' ';
}
if (in_array('distrib', $cols)) {
echo
''.(self::isDistributedModule($id) ?
' ';
}
if (!empty($actions) && $this->core->auth->isSuperAdmin()) {
$buttons = $this->getActions($id, $module, $actions);
echo
''.
''.
' ';
}
echo
' ';
$count++;
}
echo
'
'.__('No module matches your search.').'
';
}
return $this;
}
/**
* Get action buttons to add to modules list.
*
* @param string $id Module ID
* @param array $module Module info
* @param array $actions Actions keys
* @return Array of actions buttons
*/
protected function getActions($id, $module, $actions)
{
$submits = array();
# Use loop to keep requested order
foreach($actions as $action) {
switch($action) {
# Deactivate
case 'activate': if ($module['root_writable']) {
$submits[] =
'';
$sort_field = $this->getSort();
# Sort modules by id
$modules = $this->getSearch() === null ?
self::sortModules($this->data, $sort_field, $this->sort_asc) :
$this->data;
$res = '';
$count = 0;
foreach ($modules as $id => $module)
{
# Show only requested modules
if ($nav_limit && $this->getSearch() === null) {
$char = substr($module[$sort_field], 0, 1);
if (!in_array($char, $this->nav_list)) {
$char = $this->nav_special;
}
if ($this->getIndex() != $char) {
continue;
}
}
$current = $this->core->blog->settings->system->theme == $id && $this->modules->moduleExists($id);
$distrib = self::isDistributedModule($id) ? ' dc-box' : '';
$line =
'
';
if (in_array('name', $cols)) {
$line .=
'
'.html::escapeHTML($module['name']).' ';
}
# Display score only for debug purpose
if (in_array('score', $cols) && $this->getSearch() !== null && defined('DC_DEBUG') && DC_DEBUG) {
$line .=
'
'.sprintf(__('Score: %s'), $module['score']).'
';
}
if (in_array('sshot', $cols)) {
# Screenshot from url
if (preg_match('#^http(s)?://#', $module['sshot'])) {
$sshot = $module['sshot'];
}
# Screenshot from installed module
elseif (file_exists($this->core->blog->themes_path.'/'.$id.'/screenshot.jpg')) {
$sshot = $this->getURL('shot='.rawurlencode($id));
}
# Default screenshot
else {
$sshot = 'images/noscreenshot.png';
}
$line .=
'
';
}
$line .=
'
'.
'
';
if (in_array('desc', $cols)) {
$line .=
''.html::escapeHTML($module['desc']).' ';
}
if (in_array('author', $cols)) {
$line .=
''.sprintf(__('by %s'),html::escapeHTML($module['author'])).' ';
}
if (in_array('version', $cols)) {
$line .=
''.sprintf(__('version %s'),html::escapeHTML($module['version'])).' ';
}
if (in_array('current_version', $cols)) {
$line .=
''.sprintf(__('(current version %s)'),html::escapeHTML($module['current_version'])).' ';
}
if (in_array('parent', $cols) && !empty($module['parent'])) {
if ($this->modules->moduleExists($module['parent'])) {
$line .=
''.sprintf(__('(built on "%s")'),html::escapeHTML($module['parent'])).' ';
}
else {
$line .=
''.sprintf(__('(requires "%s")'),html::escapeHTML($module['parent'])).' ';
}
}
$has_details = in_array('details', $cols) && !empty($module['details']);
$has_support = in_array('support', $cols) && !empty($module['support']);
if ($has_details || $has_support) {
$line .=
'';
if ($has_details) {
$line .=
''.__('Details').' ';
}
if ($has_support) {
$line .=
' - '.__('Support').' ';
}
$line .=
' ';
}
$line .=
'
'.
'
';
$line .=
'
';
# Plugins actions
if ($current) {
# _GET actions
if (file_exists(path::real($this->core->blog->themes_path.'/'.$id).'/style.css')) {
$theme_url = preg_match('#^http(s)?://#', $this->core->blog->settings->system->themes_url) ?
http::concatURL($this->core->blog->settings->system->themes_url, '/'.$id) :
http::concatURL($this->core->blog->url, $this->core->blog->settings->system->themes_url.'/'.$id);
$line .=
'
'.__('View stylesheet').'
';
}
$line .= '
';
if (file_exists(path::real($this->core->blog->themes_path.'/'.$id).'/_config.php')) {
$line .=
'
'.__('Configure theme').'
';
}
# --BEHAVIOR-- adminCurrentThemeDetails
$line .=
$this->core->callBehavior('adminCurrentThemeDetails', $this->core, $id, $module);
$line .= '
';
}
# _POST actions
if (!empty($actions)) {
$line .=
'
';
}
$line .=
'
';
$line .=
'
';
$count++;
$res = $current ? $line.$res : $res.$line;
}
echo
$res.
'
'.__('No module matches your search.').'
';
}
}
protected function getActions($id, $module, $actions)
{
$submits = array();
$this->core->blog->settings->addNamespace('system');
if ($id != $this->core->blog->settings->system->theme) {
# Select theme to use on curent blog
if (in_array('select', $actions) && $this->path_writable) {
$submits[] =
' 
'
: '').'