SWAMPy

✎ CARVE FLESH

EDITING: search_term_helper.rb

# frozen_string_literal: true

#
# Copyright (C) 2013 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

module SearchTermHelper
  MIN_SEARCH_TERM_LENGTH = 2

module ClassMethods
    # Searches the given scope for rows with column values
    # like the search term.
    #
    # @param scope The scope to limit the search to
    # @param attr  The attribute (column) the search should consider
    # @param search_term The term being searched for
    # @param normalize_unicode Defaults to false. If set to true, the
    #   search will consider the NFC and NFD representations of the
    #   given search_term
    #
    # @returns A new scope with the search filter applied. If the given
    #   scope was something like an AR relation (i.e. responds to 'where')
    #   returns a new scope of the same type. Otherwise returns an Array
    def search_by_attribute(scope, attr, search_term, normalize_unicode: false)
      return scope unless search_term.present?

SearchTermHelper.validate_search_term(search_term)
      filtered_scope(scope, attr, search_term, normalize_unicode)
    end

private

def filtered_scope(*filter_args, normalize_unicode)
      # Return the filter query, don't bother worrying about unicode
      # normalization.
      return non_normalized_results(*filter_args) unless normalize_unicode

# Return the filter query, but do worry about doing basic
      # unicode normalization. Adds an OR to the query to take into
      # account both NFC and NFD representations of the search_term
      #
      # See https://www.win.tue.nl/~aeb/linux/uc/nfc_vs_nfd.html
      normalized_results(*filter_args)
    end

def non_normalized_results(scope, attr, search_term)
      return scope.where(wildcard("#{table_name}.#{attr}", search_term)) if scope.respond_to?(:where)

scope.select { |item| item.matches_attribute?(attr, search_term) }
    end

def normalized_results(scope, attr, search_term)
      # TODO: investigate the PG "NORMALIZE" function once on PG 13
      nfc_search_term, nfd_search_term = normalized_search_terms(search_term)

if scope.respond_to?(:where)
        # Consider the NFC and NFD representations of the search_term by using an
        # OR operator
        return scope.where(wildcard("#{table_name}.#{attr}", nfc_search_term)).or(
          scope.where(wildcard("#{table_name}.#{attr}", nfd_search_term))
        )
      end

scope.select do |item|
        item.matches_attribute?(attr, nfc_search_term) ||
          item.matches_attribute?(attr, nfd_search_term)
      end
    end

def normalized_search_terms(search_term)
      [
        search_term.unicode_normalize,
        search_term.unicode_normalize(:nfd)
      ]
    end
  end

def self.included(klass)
    klass.extend(ClassMethods)
  end

class SearchTermTooShortError < ArgumentError
    def response_status
      :bad_request
    end

def error_json
      {
        "errors" => [{
          "field" => "search_term",
          "code" => "invalid",
          "message" => "#{SearchTermHelper::MIN_SEARCH_TERM_LENGTH} or more characters is required"
        }]
      }
    end
  end

def self.valid_search_term?(search_term)
    search_term.is_a?(String) && search_term.length >= MIN_SEARCH_TERM_LENGTH
  end

def self.validate_search_term(search_term)
    raise SearchTermTooShortError unless valid_search_term?(search_term)
  end

def matches_attribute?(attr, search_term)
    self[attr].to_s.downcase.include?(search_term.downcase)
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 address_book/	DIR	—	2023-09-24 03:36
📁 api/	DIR	—	2023-09-24 03:39
📁 app_center/	DIR	—	2023-09-24 03:36
📁 authentication_methods/	DIR	—	2023-09-24 03:36
📁 base/	DIR	—	2023-09-24 03:39
📁 basic_lti/	DIR	—	2023-09-24 03:39
📁 canvadocs/	DIR	—	2023-09-24 03:36
📁 canvas/	DIR	—	2023-09-24 03:39
📁 cc/	DIR	—	2023-09-24 03:39
📁 cdc_migration_testing/	DIR	—	2023-09-24 03:36
📁 data_fixup/	DIR	—	2023-09-24 03:39
📁 external_auth_observation/	DIR	—	2023-09-24 03:36
📁 feature_flags/	DIR	—	2023-09-24 03:36
📁 global_lookups/	DIR	—	2023-09-24 03:36
📁 gradebook/	DIR	—	2023-09-24 03:39
📁 i18n/	DIR	—	2023-09-24 03:36
📁 latex/	DIR	—	2023-09-24 03:36
📁 lti/	DIR	—	2023-09-24 03:39
📁 messageable_user/	DIR	—	2023-09-24 03:36
📁 microsoft_sync/	DIR	—	2023-09-24 03:39
📁 migration_helpers/	DIR	—	2023-09-24 03:36
📁 outcomes/	DIR	—	2023-09-24 03:36
📁 rake/	DIR	—	2023-09-24 03:36
📁 reporting/	DIR	—	2023-09-24 03:36
📁 schemas/	DIR	—	2023-09-24 03:36
📁 sentry_extensions/	DIR	—	2023-09-24 03:36
📁 services/	DIR	—	2023-09-24 03:36
📁 sis/	DIR	—	2023-09-24 03:39
📁 support_helpers/	DIR	—	2023-09-24 03:39
📁 tasks/	DIR	—	2023-09-24 03:39
📁 turnitin/	DIR	—	2023-09-24 03:39
📁 user_content/	DIR	—	2023-09-24 03:36
📁 utils/	DIR	—	2023-09-24 03:36
📄 account_services.rb	RB	3.7 KB	2023-09-24 03:36	EDIT
📄 address_book.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 anonymity.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 api.rb	RB	27.8 KB	2023-09-24 03:39	EDIT
📄 api_route_set.rb	RB	4.5 KB	2023-09-24 03:39	EDIT
📄 asset_signature.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 assignment_override_applicator.rb	RB	20.2 KB	2023-09-24 03:36	EDIT
📄 assignment_util.rb	RB	5.3 KB	2023-09-24 03:36	EDIT
📄 authentication_methods.rb	RB	16 KB	2023-09-24 03:36	EDIT
📄 basic_lti.rb	RB	732 B	2023-09-24 03:36	EDIT
📄 brand_account_chain_resolver.rb	RB	3.5 KB	2023-09-24 03:36	EDIT
📄 brand_config_helpers.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 brand_config_regenerator.rb	RB	5.5 KB	2023-09-24 03:36	EDIT
📄 brandable_css.rb	RB	14.5 KB	2023-09-24 03:36	EDIT
📄 browser_support.rb	RB	2.5 KB	2023-09-24 03:36	EDIT
📄 canvadocs.rb	RB	13.1 KB	2023-09-24 03:36	EDIT
📄 canvas_logger.rb	RB	2.9 KB	2023-09-24 03:36	EDIT
📄 capture_job_ids.rb	RB	893 B	2023-09-24 03:36	EDIT
📄 cc.rb	RB	785 B	2023-09-24 03:36	EDIT
📄 content_licenses.rb	RB	2.4 KB	2023-09-24 03:36	EDIT
📄 content_notices.rb	RB	2.6 KB	2023-09-24 03:36	EDIT
📄 content_zipper.rb	RB	17.2 KB	2023-09-24 03:39	EDIT
📄 conversation_batch_scrubber.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 conversation_helper.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 copy_authorized_links.rb	RB	2.8 KB	2023-09-24 03:39	EDIT
📄 course_link_validator.rb	RB	11.2 KB	2023-09-24 03:39	EDIT
📄 course_pace_due_dates_calculator.rb	RB	2.5 KB	2023-09-24 03:36	EDIT
📄 course_pace_hard_end_date_compressor.rb	RB	9.9 KB	2023-09-24 03:36	EDIT
📄 course_paces_date_helpers.rb	RB	2.5 KB	2023-09-24 03:36	EDIT
📄 custom_validations.rb	RB	2 KB	2023-09-24 03:39	EDIT
📄 cuty_capt.rb	RB	5.8 KB	2023-09-24 03:36	EDIT
📄 dates_overridable.rb	RB	10.6 KB	2023-09-24 03:36	EDIT
📄 delayed_message_scrubber.rb	RB	1023 B	2023-09-24 03:36	EDIT
📄 differentiable_assignment.rb	RB	3.9 KB	2023-09-24 03:39	EDIT
📄 due_date_cacher.rb	RB	22.7 KB	2023-09-24 03:39	EDIT
📄 dump_helper.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 duplicating_objects.rb	RB	2.8 KB	2023-09-24 03:36	EDIT
📄 effective_due_dates.rb	RB	16.3 KB	2023-09-24 03:36	EDIT
📄 email_address_validator.rb	RB	932 B	2023-09-24 03:36	EDIT
📄 enrollments_from_user_list.rb	RB	3.4 KB	2023-09-24 03:39	EDIT
📄 eportfolio_page.rb	RB	3 KB	2023-09-24 03:36	EDIT
📄 external_feed_aggregator.rb	RB	3.6 KB	2023-09-24 03:36	EDIT
📄 external_statuses.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 feature.rb	RB	9.3 KB	2023-09-24 03:36	EDIT
📄 feature_flags.rb	RB	8.8 KB	2023-09-24 03:39	EDIT
📄 file_authenticator.rb	RB	5.3 KB	2023-09-24 03:36	EDIT
📄 file_in_context.rb	RB	3.4 KB	2023-09-24 03:36	EDIT
📄 file_splitter.rb	RB	1.2 KB	2023-09-24 03:36	EDIT
📄 global_lookups.rb	RB	1019 B	2023-09-24 03:36	EDIT
📄 google_docs_preview.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 grade_calculator.rb	RB	40.7 KB	2023-09-24 03:36	EDIT
📄 gradebook_exporter.rb	RB	17.5 KB	2023-09-24 03:39	EDIT
📄 gradebook_grading_period_assignments.rb	RB	2.6 KB	2023-09-24 03:36	EDIT
📄 gradebook_importer.rb	RB	31.7 KB	2023-09-24 03:39	EDIT
📄 gradebook_settings_helpers.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 gradebook_user_ids.rb	RB	9.1 KB	2023-09-24 03:36	EDIT
📄 grading_period_helper.rb	RB	1011 B	2023-09-24 03:36	EDIT
📄 has_content_tags.rb	RB	2.6 KB	2023-09-24 03:36	EDIT
📄 health_checks.rb	RB	7.3 KB	2023-09-24 03:36	EDIT
📄 host_url.rb	RB	3.8 KB	2023-09-24 03:36	EDIT
📄 i18n_time_zone.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 imported_html_converter.rb	RB	2.7 KB	2023-09-24 03:39	EDIT
📄 inst_fs.rb	RB	18.8 KB	2023-09-24 03:39	EDIT
📄 late_policy_applicator.rb	RB	3.7 KB	2023-09-24 03:36	EDIT
📄 latex.rb	RB	837 B	2023-09-24 03:36	EDIT
📄 learning_outcome_context.rb	RB	3.2 KB	2023-09-24 03:39	EDIT
📄 locale_selection.rb	RB	5.8 KB	2023-09-24 03:36	EDIT
📄 locked_for.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 logging_filter.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 login_hooks.rb	RB	999 B	2023-09-24 03:36	EDIT
📄 material_changes.rb	RB	958 B	2023-09-24 03:36	EDIT
📄 math_man.rb	RB	1.8 KB	2023-09-24 03:36	EDIT
📄 message_dispatcher.rb	RB	3.3 KB	2023-09-24 03:36	EDIT
📄 message_scrubber.rb	RB	3.6 KB	2023-09-24 03:36	EDIT
📄 messageable_user.rb	RB	7.4 KB	2023-09-24 03:36	EDIT
📄 missing_policy_applicator.rb	RB	3 KB	2023-09-24 03:36	EDIT
📄 model_cache.rb	RB	4.5 KB	2023-09-24 03:39	EDIT
📄 moderation.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 must_view_module_progressor.rb	RB	3 KB	2023-09-24 03:36	EDIT
📄 mutable.rb	RB	5.1 KB	2023-09-24 03:36	EDIT
📄 net_ldap_extensions.rb	RB	4.1 KB	2023-09-24 03:36	EDIT
📄 notification_message_creator.rb	RB	17.1 KB	2023-09-24 03:39	EDIT
📄 package_root.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 permissions.rb	RB	1.8 KB	2023-09-24 03:36	EDIT
📄 permissions_helper.rb	RB	11 KB	2023-09-24 03:36	EDIT
📄 plannable.rb	RB	10 KB	2023-09-24 03:36	EDIT
📄 planner_api_helper.rb	RB	3 KB	2023-09-24 03:39	EDIT
📄 planner_helper.rb	RB	3.8 KB	2023-09-24 03:36	EDIT
📄 progress_runner.rb	RB	4 KB	2023-09-24 03:36	EDIT
📄 pronouns.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 quiz_math_data_fixup.rb	RB	6 KB	2023-09-24 03:39	EDIT
📄 request_error.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 rubric_context.rb	RB	1.9 KB	2023-09-24 03:39	EDIT
📄 scope_filter.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 score_statistics_generator.rb	RB	7 KB	2023-09-24 03:36	EDIT
📄 scrypt_provider.rb	RB	1.3 KB	2023-09-24 03:36	EDIT
📄 search_term_helper.rb	RB	4 KB	2023-09-24 03:36	EDIT
📄 send_to_stream.rb	RB	3.6 KB	2023-09-24 03:39	EDIT
📄 sentry_proxy.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 session_token.rb	RB	2.8 KB	2023-09-24 03:36	EDIT
📄 simple_stats.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 simple_tags.rb	RB	3 KB	2023-09-24 03:39	EDIT
📄 sis.rb	RB	769 B	2023-09-24 03:36	EDIT
📄 sorts_assignments.rb	RB	4.5 KB	2023-09-24 03:36	EDIT
📄 ssl_common.rb	RB	2.1 KB	2023-09-24 03:39	EDIT
📄 stats.rb	RB	4.4 KB	2023-09-24 03:36	EDIT
📄 sticky_sis_fields.rb	RB	4.9 KB	2023-09-24 03:39	EDIT
📄 submission_list.rb	RB	13.6 KB	2023-09-24 03:39	EDIT
📄 submission_search.rb	RB	4.4 KB	2023-09-24 03:39	EDIT
📄 submittable.rb	RB	7.4 KB	2023-09-24 03:36	EDIT
📄 submittables_grading_period_protection.rb	RB	7.7 KB	2023-09-24 03:36	EDIT
📄 summary_message_consolidator.rb	RB	2.9 KB	2023-09-24 03:36	EDIT
📄 syslog_wrapper.rb	RB	4.2 KB	2023-09-24 03:36	EDIT
📄 text_helper.rb	RB	9.6 KB	2023-09-24 03:36	EDIT
📄 time_zone_helper.rb	RB	3 KB	2023-09-24 03:36	EDIT
📄 timed_cache.rb	RB	1003 B	2023-09-24 03:36	EDIT
📄 token_scopes.rb	RB	6.7 KB	2023-09-24 03:36	EDIT
📄 token_scopes_helper.rb	RB	933 B	2023-09-24 03:36	EDIT
📄 turnitin.rb	RB	14.8 KB	2023-09-24 03:39	EDIT
📄 turnitin_id.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 unzip_attachment.rb	RB	10.5 KB	2023-09-24 03:36	EDIT
📄 user_content.rb	RB	8.2 KB	2023-09-24 03:39	EDIT
📄 user_list.rb	RB	13.3 KB	2023-09-24 03:36	EDIT
📄 user_list_v2.rb	RB	9.1 KB	2023-09-24 03:36	EDIT
📄 user_merge.rb	RB	36.1 KB	2023-09-24 03:39	EDIT
📄 user_search.rb	RB	12.6 KB	2023-09-24 03:39	EDIT
📄 uuid_helper.rb	RB	881 B	2023-09-24 03:36	EDIT
📄 vericite.rb	RB	17.7 KB	2023-09-24 03:36	EDIT
📄 visibility_plucking_helper.rb	RB	2.2 KB	2023-09-24 03:36	EDIT
📄 zip_extractor.rb	RB	2.1 KB	2023-09-24 03:36	EDIT