From a59a9a726166782977c3a3cb55fdc57bccb8f5ae Mon Sep 17 00:00:00 2001 From: ppound Date: Wed, 29 Sep 2021 14:55:10 -0300 Subject: [PATCH] top level module now installs and can display search block --- roblib_search.info | 9 - roblib_search.info.yml | 9 + roblib_search.install | 44 ---- roblib_search.module | 266 +--------------------- roblib_search.routing.yml | 7 + src/Form/RoblibSearchForm.php | 79 +++++++ src/Form/RoblibSearchSettingsForm.php | 57 +++++ src/Plugin/Block/RoblibSearchBoxBlock.php | 26 +++ 8 files changed, 183 insertions(+), 314 deletions(-) delete mode 100644 roblib_search.info create mode 100644 roblib_search.info.yml delete mode 100644 roblib_search.install create mode 100644 roblib_search.routing.yml create mode 100644 src/Form/RoblibSearchForm.php create mode 100644 src/Form/RoblibSearchSettingsForm.php create mode 100644 src/Plugin/Block/RoblibSearchBoxBlock.php diff --git a/roblib_search.info b/roblib_search.info deleted file mode 100644 index d5a1179..0000000 --- a/roblib_search.info +++ /dev/null @@ -1,9 +0,0 @@ -name = Roblib Search -configure = admin/roblib_search/configure -description = Provides a search form and fires a hook when the search is submitted. Other modules should implement the search functionality by implementing the correct hooks. -package = Roblib Search -dependencies[] = apachesolr_access -dependencies[] = views_ui -version = 7.x-dev -core = 7.x -stylesheets[all][] = css/roblib_search.base.css \ No newline at end of file diff --git a/roblib_search.info.yml b/roblib_search.info.yml new file mode 100644 index 0000000..e086b08 --- /dev/null +++ b/roblib_search.info.yml @@ -0,0 +1,9 @@ +name: Roblib Search +type: module +core_version_requirement: ^8.9 || ^9 +configure: roblib_search.settings +description: Provides a search form and fires a hook when the search is submitted. Other modules should implement the search functionality by implementing the correct hooks. +package: Roblib Search +dependancies: + - apachesolr_access + - views_ui \ No newline at end of file diff --git a/roblib_search.install b/roblib_search.install deleted file mode 100644 index 5eb7a7d..0000000 --- a/roblib_search.install +++ /dev/null @@ -1,44 +0,0 @@ - 'stores search data such as date/time ip etc.', - 'fields' => array( - 'sid' => array( - 'type' => 'serial', - 'not null' => TRUE, - 'description' => 'unique id for each row', - ), - 'query' => array( - 'description' => 'the search string', - 'type' => 'varchar', - 'not null' => TRUE, - 'length' => 1024, - ), - 'searched_date' => array( - 'description' => 'the date the search request occured', - 'type' => 'varchar', - 'mysql_type' => 'DATETIME', - 'not null' => TRUE, - ), - 'ipaddress' => array( - 'description' => 'the ip or domain of the users computer ', - 'type' => 'varchar', - 'not null' => TRUE, - 'length' => 255, - ), - ), - 'primary key' => array('sid'), - ); - return $schema; -} - diff --git a/roblib_search.module b/roblib_search.module index 4530da4..9cc89c3 100644 --- a/roblib_search.module +++ b/roblib_search.module @@ -28,138 +28,6 @@ function roblib_search_menu() { return $items; } - -/** - * A form for managing the modules configuration. - * - * @param array $form - * A Drupal form array - * @param array $form_state - * A Drupal formstate array - * - * @return array - * A Drupal form - */ -function roblib_search_config_form($form, &$form_state) { - - $form['roblib_search_panel_page'] = array( - '#type' => 'textfield', - '#title' => t('Path to the roblib search panel page'), - '#default_value' => variable_get('roblib_search_panel_page', '/roblib/panel'), - '#description' => t('The Path to the Roblib Search Panel, for example /roblib/panel'), - '#required' => TRUE, - ); - - return system_settings_form($form); -} - -/** - * Implements hook_admin_paths(). - */ -function roblib_search_admin_paths() { - $paths = array( - 'admin/roblib/search' => TRUE, - ); - return $paths; -} - -function roblib_search_views_data(){ - $data['roblib_search_log']['table']['group'] = t('Roblib Search log'); - $data['roblib_search_log']['table']['base'] = array( - 'field' => 'sid', // This is the identifier field for the view. - 'title' => t('Roblib Search log'), - 'help' => t('Contains the Roblib Bento box search query strings.'), - 'weight' => -10, - ); - - // The individual fields. - $data['roblib_search_log']['query'] = array( - 'title' => t('the query string field'), - 'help' => t('a plain text field.'), - 'field' => array( - 'handler' => 'views_handler_field', - 'click sortable' => TRUE, // This is use by the table display plugin. - ), - 'sort' => array( - 'handler' => 'views_handler_sort', - ), - 'filter' => array( - 'handler' => 'views_handler_filter_string', - ), - 'argument' => array( - 'handler' => 'views_handler_argument_string', - ), - ); - $data['roblib_search_log']['sid'] = array( - 'title' => t('Numeric field'), - 'help' => t('the unique identifier for each row'), - 'field' => array( - 'handler' => 'views_handler_field_numeric', - 'click sortable' => TRUE, - ), - 'filter' => array( - 'handler' => 'views_handler_filter_numeric', - ), - 'sort' => array( - 'handler' => 'views_handler_sort', - ), - ); - - - $data['roblib_search_log']['ipaddress'] = array( - 'title' => t('the ipaddress of the user who submitted the search'), - 'help' => t('a plain text field.'), - 'field' => array( - 'handler' => 'views_handler_field', - 'click sortable' => TRUE, // This is use by the table display plugin. - ), - 'sort' => array( - 'handler' => 'views_handler_sort', - ), - 'filter' => array( - 'handler' => 'views_handler_filter_string', - ), - 'argument' => array( - 'handler' => 'views_handler_argument_string', - ), - ); - - $data['roblib_search_log']['searched_date'] = array( - 'title' => t('Timestamp field'), - 'help' => t('a timestamp field.'), - 'field' => array( - 'handler' => 'views_handler_field', - 'click sortable' => TRUE, - ), - 'argument' => array('handler' => 'views_handler_argument_date'), - 'sort' => array( - 'handler' => 'views_handler_sort_date', - ), - 'filter' => array( - 'handler' => 'roblib_search_handler_filter_datetime', - ), - ); - - return $data; -} - -/** - * Implements hook_permission(). - */ -function roblib_search_permission() { - return array( - 'search roblib' => array( - 'title' => t('Search all configured targets'), - 'description' => t('Search all Roblib configured targets. This permission exposes the search blocks and allows you to see search results.'), - ), - 'administer roblib search' => array( - 'title' => t('Administer Roblib Search'), - 'description' => t('Administer settings for the Roblib search client.'), - ), - ); -} - - /** * Implements hook_block_info(). */ @@ -180,7 +48,7 @@ function roblib_search_block_info() { /** * Implements hook_theme(). */ -function roblib_search_theme() { +/*function roblib_search_theme() { $path = drupal_get_path('module', 'roblib_search'); $file = 'theme.inc'; @@ -192,32 +60,18 @@ function roblib_search_theme() { 'variables' => array('results' => NULL), ) ); -} +}*/ + -/** - * Hook the panels pane preprocessor so we can wrap it in a div for themeing. - * - * @param array $variables - * Drupal variables array - * @param $hook - */ -function roblib_search_preprocess_panels_pane(&$variables, $hook){ - switch ($variables['pane']->subtype) { - case 'roblib_search-roblib_search_other': - $variables['title_prefix'] = '
'; - $variables['title_suffix'] = '
'; - break; - } -} /** * Implements hook_init(). */ -function roblib_search_init() { +/*function roblib_search_init() { drupal_add_js(drupal_get_path('module', 'roblib_search') . '/js/imagesloaded.pkg.min.js'); drupal_add_js(drupal_get_path('module', 'roblib_search') . '/js/roblib_search.js'); drupal_add_css(drupal_get_path('module', 'roblib_search') . '/css/jquery.qtip.min.css'); -} +}*/ /** * Implements hook_block_view(). @@ -236,82 +90,6 @@ function roblib_search_block_view($delta = '') { return $block; } -/** - * Roblib search simple search form submit. - * - * @param array $form - * Drupal form array - * @param array $form_state - * Drupal formstate array - */ -function roblib_search_simple_form_submit($form, &$form_state) { - global $base_url; - $form_state['rebuild'] = TRUE; - $search_string = $form_state['values']['roblib_search_simple_search_query']; - $search_string = filter_xss($search_string); - roblib_search_log_query($search_string); - $redirect_url = variable_get('roblib_search_panel_page', 'roblib/panel'); - $redirect_url = $base_url . '/' . $redirect_url; - drupal_goto($redirect_url, array('query' => array('roblib_query' => $search_string))); -} - -/** - * Logs a search query to a database table. - * - * @param string $search_string - * The query to log - */ -function roblib_search_log_query($search_string) { - $eid = db_insert('roblib_search_log') - ->fields(array( - 'query' => $search_string, - 'searched_date' => format_date(time(), 'custom', 'Y-m-d H:i:s'), - 'ipaddress' => ip_address(), - )) - ->execute(); -} - -/** - * Roblib search simple search form. - * - * @param array $form - * Drupal form array - * @param array $form_state - * Drupal formstate - * - * @return array - * A Drupal formapi array - */ -function roblib_search_simple_form($form, &$form_state) { - if (isset($_GET['roblib_query'])) { - $query = $_GET['roblib_query']; - } - else { - $query = ''; - } - - $form['simple'] = array( - '#type' => 'container', - '#attributes' => array( - 'class' => array( - 'container-inline' - ) - ) - ); - $form['simple']["roblib_search_simple_search_query"] = array( - '#size' => '15', - '#type' => 'textfield', - '#title' => '', - '#required' => TRUE, - '#default_value' => $query, - ); - $form['simple']['submit'] = array( - '#type' => 'submit', - '#value' => t('search') - ); - return $form; -} - /** * Implements hook_help(). */ @@ -327,37 +105,3 @@ function roblib_search_help($path, $arg) { ); } } - -class roblib_search_handler_filter_datetime extends views_handler_filter_date { - function op_between($field) { - if ($this->operator == 'between') { - $a = intval(strtotime($this->value['min'], 0)); - $b = intval(strtotime($this->value['max'], 0)); - } - else { - $a = intval(strtotime($this->value['max'], 0)); - $b = intval(strtotime($this->value['min'], 0)); - } - - if ($this->value['type'] == 'offset') { - // changed from original - $a = (integer)time() + (integer)sprintf('%+d', $a); // keep sign - $b = (integer)time() + (integer)sprintf('%+d', $b); // keep sign - // changed from original ends - } - // %s is safe here because strtotime scrubbed the input and we might - // have a string if using offset. - $this->query->add_where_expression($this->options['group'], "$field >= '".date("Y-m-d H:i:s", $a)."'"); - $this->query->add_where_expression($this->options['group'], "$field <= '".date("Y-m-d H:i:s", $b)."'"); - } - - function op_simple($field) { - $value = intval(strtotime($this->value['value'], 0)); - if (!empty($this->value['type']) && $this->value['type'] == 'offset') { - $this->query->add_where_expression($this->options['group'], "$field $this->operator DATE_ADD(NOW(), INTERVAL $value SECOND)"); - } else { - $this->query->add_where_expression($this->options['group'], "$field $this->operator $value"); - } - } -} - diff --git a/roblib_search.routing.yml b/roblib_search.routing.yml new file mode 100644 index 0000000..ea851c4 --- /dev/null +++ b/roblib_search.routing.yml @@ -0,0 +1,7 @@ +roblib_search.settings: + path: '/admin/config/system/roblib_search' + defaults: + _form: '\Drupal\roblib_search\Form\RoblibSearchSettingsForm' + _title: 'Roblib Search Settings Form' + requirements: + _permission: 'administer site configuration' \ No newline at end of file diff --git a/src/Form/RoblibSearchForm.php b/src/Form/RoblibSearchForm.php new file mode 100644 index 0000000..181595c --- /dev/null +++ b/src/Form/RoblibSearchForm.php @@ -0,0 +1,79 @@ + 'container', + '#attributes' => array( + 'class' => array( + 'container-inline' + ) + ) + ); + $form['simple']["roblib_search_simple_search_query"] = array( + '#size' => '15', + '#type' => 'textfield', + '#title' => '', + '#required' => TRUE, + '#default_value' => $query, + ); + $form['simple']['submit'] = array( + '#type' => 'submit', + '#value' => t('search') + ); + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateForm(array &$form, FormStateInterface $form_state) { + + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + global $base_url; + //$form_state->rebuild(TRUE); + $search_string = $form_state->getValue('roblib_search_simple_search_query'); + $search_string = Html::escape($search_string); + //roblib_search_log_query($search_string); + $config = \Drupal::config('roblib_search.settings'); + $redirect_url = $config->get('search_panel_page'); + $redirect_url = $base_url . '/' . $redirect_url; + //TODO redirect to the search page + $form_state->setRedirect(''); + + } + +} diff --git a/src/Form/RoblibSearchSettingsForm.php b/src/Form/RoblibSearchSettingsForm.php new file mode 100644 index 0000000..ad0e987 --- /dev/null +++ b/src/Form/RoblibSearchSettingsForm.php @@ -0,0 +1,57 @@ + 'textfield', + '#title' => t('Path to the roblib search panel page'), + '#default_value' => $config->get('search_panel_page'), + '#description' => t('The Path to the Roblib Search Panel, for example /roblib/panel'), + '#required' => TRUE, + ); + $form['actions']['submit'] = [ + '#type' => 'submit', + '#value' => t('Save'), + '#button_type' => 'primary', + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateForm(array &$form, FormStateInterface $form_state) { + + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $config = \Drupal::configFactory()->getEditable('roblib_search.settings'); + $config->set('search_panel_page', $form_state->getValue('search_panel_page'))->save(); + } + +} diff --git a/src/Plugin/Block/RoblibSearchBoxBlock.php b/src/Plugin/Block/RoblibSearchBoxBlock.php new file mode 100644 index 0000000..334f12f --- /dev/null +++ b/src/Plugin/Block/RoblibSearchBoxBlock.php @@ -0,0 +1,26 @@ +getForm('\Drupal\roblib_search\Form\RoblibSearchForm'); + + return $form; + } +}