module_filter.module 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. <?php
  2. /**
  3. * @file
  4. * This is the file description for Module Filter module.
  5. *
  6. * In this more verbose, multi-line description, you can specify what this
  7. * file does exactly. Make sure to wrap your documentation in column 78 so
  8. * that the file can be displayed nicely in default-sized consoles.
  9. *
  10. * @author greenSkin
  11. */
  12. /**
  13. * Implements hook_perm().
  14. */
  15. function module_filter_permission() {
  16. return array(
  17. 'administer module filter' => array(
  18. 'title' => t('Administer Module Filter'),
  19. 'description' => t('Configure how Module Filter performs.'),
  20. ),
  21. );
  22. }
  23. /**
  24. * Implements hook_menu().
  25. */
  26. function module_filter_menu() {
  27. $items['admin/config/user-interface/modulefilter'] = array(
  28. 'title' => 'Module filter',
  29. 'description' => 'Configure how the modules page looks and acts.',
  30. 'access arguments' => array('administer module filter'),
  31. 'page callback' => 'drupal_get_form',
  32. 'page arguments' => array('module_filter_settings'),
  33. 'file' => 'module_filter.admin.inc',
  34. );
  35. return $items;
  36. }
  37. /**
  38. * Implements hook_menu_alter().
  39. */
  40. function module_filter_menu_alter(&$items) {
  41. if (isset($items['admin/reports/updates'])) {
  42. // We route the updates report page through us.
  43. $items['admin/reports/updates']['page callback'] = 'module_filter_update_status';
  44. $items['admin/reports/updates']['file'] = 'module_filter.pages.inc';
  45. $items['admin/reports/updates']['module'] = 'module_filter';
  46. }
  47. }
  48. /**
  49. * Implements hook_form_FORM_ID_alter().
  50. */
  51. function module_filter_form_system_modules_alter(&$form, &$form_state, $form_id) {
  52. // Don't alter the form when confirming.
  53. if (isset($form['confirm'])) {
  54. return;
  55. }
  56. $form['module_filter'] = array(
  57. '#type' => 'module_filter',
  58. '#attached' => array(
  59. 'js' => array(
  60. drupal_get_path('module', 'module_filter') . '/js/modules.js' => array('weight' => 1),
  61. ),
  62. ),
  63. );
  64. $checkbox_defaults = array(
  65. ((isset($_GET['enabled'])) ? $_GET['enabled'] : 1) ? 'enabled' : '',
  66. ((isset($_GET['disabled'])) ? $_GET['disabled'] : 1) ? 'disabled' : '',
  67. ((isset($_GET['required'])) ? $_GET['required'] : 1) ? 'required' : '',
  68. ((isset($_GET['unavailable'])) ? $_GET['unavailable'] : 1) ? 'unavailable' : '',
  69. );
  70. $form['module_filter']['show'] = array(
  71. '#type' => 'checkboxes',
  72. '#default_value' => array_filter($checkbox_defaults),
  73. '#options' => array('enabled' => t('Enabled'), 'disabled' => t('Disabled'), 'required' => t('Required'), 'unavailable' => t('Unavailable')),
  74. '#prefix' => '<div id="module-filter-show-wrapper">',
  75. '#suffix' => '</div>',
  76. );
  77. if (variable_get('module_filter_tabs', 1)) {
  78. $form['module_filter']['#attached']['css'][] = drupal_get_path('module', 'module_filter') . '/css/module_filter_tab.css';
  79. $form['module_filter']['#attached']['library'][] = array('system', 'jquery.bbq');
  80. $form['module_filter']['#attached']['js'][drupal_get_path('module', 'module_filter') . '/js/module_filter_tab.js'] = array('weight' => 2);
  81. if (!module_exists('page_actions') && variable_get('module_filter_dynamic_save_position', 1)) {
  82. $form['module_filter']['#attached']['css'][] = drupal_get_path('module', 'module_filter') . '/css/dynamic_position.css';
  83. $form['module_filter']['#attached']['js'][drupal_get_path('module', 'module_filter') . '/js/dynamic_position.js'] = array('weight' => 3);
  84. }
  85. $form['#attached']['css'][] = drupal_get_path('module', 'module_filter') . '/css/modules.css';
  86. $form['#theme'] = 'module_filter_system_modules_tabs';
  87. }
  88. $form['#submit'][] = 'module_filter_system_modules_submit_redirect';
  89. if (variable_get('module_filter_track_recent_modules', 1)) {
  90. $form['#submit'][] = 'module_filter_system_modules_submit_recent';
  91. }
  92. }
  93. /**
  94. * Implements hook_form_FORM_ID_alter().
  95. */
  96. function module_filter_form_user_admin_permissions_alter(&$form, &$form_state) {
  97. $form['module_filter'] = array(
  98. '#type' => 'module_filter',
  99. '#description' => t('Filter list by module. Use the query operator "perm" to filter by permission, e.g., perm:access.'),
  100. '#attached' => array(
  101. 'js' => array(
  102. drupal_get_path('module', 'module_filter') . '/js/permissions.js',
  103. ),
  104. ),
  105. '#weight' => -100,
  106. );
  107. }
  108. /**
  109. * Implements hook_element_info().
  110. */
  111. function module_filter_element_info() {
  112. $types['module_filter'] = array(
  113. '#input' => TRUE,
  114. '#process' => array('form_process_module_filter', 'ajax_process_form'),
  115. '#weight' => -1,
  116. '#tree' => TRUE,
  117. '#theme' => 'module_filter',
  118. );
  119. return $types;
  120. }
  121. /**
  122. * Implements hook_theme().
  123. */
  124. function module_filter_theme() {
  125. return array(
  126. 'module_filter' => array(
  127. 'render element' => 'element',
  128. 'file' => 'module_filter.theme.inc',
  129. ),
  130. 'module_filter_system_modules_tabs' => array(
  131. 'render element' => 'form',
  132. 'file' => 'module_filter.theme.inc',
  133. ),
  134. 'module_filter_operations' => array(
  135. 'variables' => array('links' => array(), 'dropbutton' => FALSE),
  136. 'file' => 'module_filter.theme.inc',
  137. ),
  138. );
  139. }
  140. /**
  141. * Create and add new textfield element.
  142. *
  143. * @param $element
  144. * An associative array containing the properties and children of the
  145. * form actions container.
  146. * @param $form_state
  147. * The $form_state array for the form this element belongs to.
  148. *
  149. * @return
  150. * The processed element.
  151. */
  152. function form_process_module_filter($element, &$form_state) {
  153. $element['name'] = array(
  154. '#type' => 'textfield',
  155. '#title' => (isset($element['#title'])) ? $element['#title'] : t('Filter list'),
  156. '#default_value' => (isset($element['#default_value'])) ? $element['#default_value'] : ((isset($_GET['filter'])) ? $_GET['filter'] : ''),
  157. '#size' => (isset($element['#size'])) ? $element['#size'] : 45,
  158. '#weight' => (isset($element['#weight'])) ? $element['#weight'] : -10,
  159. '#attributes' => ((isset($element['#attributes'])) ? $element['#attributes'] : array()) + array('autocomplete' => 'off'),
  160. '#attached' => array(
  161. 'css' => array(
  162. drupal_get_path('module', 'module_filter') . '/css/module_filter.css',
  163. ),
  164. 'js' => array(
  165. 'misc/jquery.cookie.js',
  166. drupal_get_path('module', 'module_filter') . '/js/module_filter.js',
  167. array(
  168. 'data' => array(
  169. 'moduleFilter' => array(
  170. 'setFocus' => variable_get('module_filter_set_focus', 1),
  171. 'tabs' => variable_get('module_filter_tabs', 1),
  172. 'countEnabled' => variable_get('module_filter_count_enabled', 1),
  173. 'visualAid' => variable_get('module_filter_visual_aid', 1),
  174. 'hideEmptyTabs' => variable_get('module_filter_hide_empty_tabs', 0),
  175. 'dynamicPosition' => (!module_exists('page_actions')) ? variable_get('module_filter_dynamic_save_position', 1) : FALSE,
  176. 'useURLFragment' => variable_get('module_filter_use_url_fragment', 1),
  177. 'useSwitch' => variable_get('module_filter_use_switch', 1),
  178. 'trackRecent' => variable_get('module_filter_track_recent_modules', 1),
  179. 'rememberActiveTab' => variable_get('module_filter_remember_active_tab', 1),
  180. 'rememberUpdateState' => variable_get('module_filter_remember_update_state', 0),
  181. 'expandedDescription' => variable_get('module_filter_expanded_description', 0),
  182. ),
  183. ),
  184. 'type' => 'setting',
  185. ),
  186. ),
  187. ),
  188. );
  189. if (isset($element['#description'])) {
  190. $element['name']['#description'] = $element['#description'];
  191. }
  192. return $element;
  193. }
  194. /**
  195. * Form submission handler to filters module list.
  196. */
  197. function module_filter_system_modules_submit_redirect($form, &$form_state) {
  198. $query = array();
  199. if (!empty($form_state['values']['module_filter']['name'])) {
  200. $query['filter'] = $form_state['values']['module_filter']['name'];
  201. }
  202. $query['enabled'] = (int) (!empty($form_state['values']['module_filter']['show']['enabled']));
  203. $query['disabled'] = (int) (!empty($form_state['values']['module_filter']['show']['disabled']));
  204. $query['required'] = (int) (!empty($form_state['values']['module_filter']['show']['required']));
  205. $query['unavailable'] = (int) (!empty($form_state['values']['module_filter']['show']['unavailable']));
  206. $form_state['redirect'] = array(
  207. 'admin/modules',
  208. array('query' => $query),
  209. );
  210. }
  211. /**
  212. * Form submission handler to track recently enabled/disabled modules
  213. */
  214. function module_filter_system_modules_submit_recent($form, &$form_state) {
  215. $recent_modules = variable_get('module_filter_recent_modules', array());
  216. foreach ($form_state['values']['modules'] as $package => $modules) {
  217. foreach ($modules as $key => $module) {
  218. if ($form['modules'][$package][$key]['enable']['#default_value'] != $module['enable']) {
  219. $recent_modules[$key] = REQUEST_TIME;
  220. }
  221. }
  222. }
  223. variable_set('module_filter_recent_modules', $recent_modules);
  224. }
  225. /**
  226. * Create list of newly added modules (within a week)
  227. * @return
  228. * An array of newly added modules.
  229. */
  230. function module_filter_new_modules() {
  231. // Get current list of modules.
  232. $files = system_rebuild_module_data();
  233. // Remove hidden modules from display list.
  234. $visible_files = $files;
  235. foreach ($visible_files as $filename => $file) {
  236. if (!empty($file->info['hidden'])) {
  237. unset($visible_files[$filename]);
  238. }
  239. }
  240. uasort($visible_files, 'system_sort_modules_by_info_name');
  241. $new_modules = array();
  242. foreach ($visible_files as $filename => $module) {
  243. $ctime = filectime(dirname($module->uri) . '/' . $module->name . '.info');
  244. if (($ctime - strtotime('-1 week')) > 0) {
  245. $new_modules[$filename] = module_filter_get_id($filename);
  246. }
  247. }
  248. return $new_modules;
  249. }
  250. /**
  251. * Function to replace special characters with hyphen.
  252. * @param string $text
  253. * @return
  254. * String
  255. */
  256. function module_filter_get_id($text) {
  257. $id = strtolower($text);
  258. $id = preg_replace('/([^a-z0-9]+)/', '-', $id);
  259. return trim($id, '-');
  260. }
  261. /**
  262. * Function to return true/false depending on module changed time and a week timestamp
  263. * @param integer $var
  264. * @return
  265. * Boolean indicating
  266. */
  267. function module_filter_recent_filter($var) {
  268. return (!($var < REQUEST_TIME - 60 * 60 * 24 * 7));
  269. }