Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 99435381 authored by Noémi Ványi's avatar Noémi Ványi
Browse files

[enh] introduce private engines 

This PR adds a new setting to engines named `tokens`.
It expects a list of tokens which lets searx validate
if the request should be accepted or not.
parent f9c7a678

searx/__init__.py

+1 −0
Original line number Diff line number Diff line
@@ -38,6 +38,7 @@ def check_settings_yml(file_name): 
    else:

        return None





# find location of settings.yml

if 'SEARX_SETTINGS_PATH' in environ:

    # if possible set path to settings using the

searx/engines/__init__.py

+7 −2
Original line number Diff line number Diff line
@@ -54,7 +54,8 @@ engine_default_args = {'paging': False, 
                       'suspend_end_time': 0,

                       'continuous_errors': 0,

                       'time_range_support': False,

                       'offline': False}

                       'offline': False,

                       'tokens': []}





def load_engine(engine_data):
@@ -160,7 +161,7 @@ def to_percentage(stats, maxvalue): 
    return stats





def get_engines_stats():

def get_engines_stats(preferences):

    # TODO refactor

    pageloads = []

    engine_times = []
@@ -171,8 +172,12 @@ def get_engines_stats(): 


    max_pageload = max_engine_times = max_results = max_score = max_errors = max_score_per_result = 0  # noqa

    for engine in engines.values():

        if not preferences.validate_token(engine):

            continue



        if engine.stats['search_count'] == 0:

            continue



        results_num = \

            engine.stats['result_count'] / float(engine.stats['search_count'])

searx/engines/dummy-offline.py

0 → 100644
+12 −0
Original line number Diff line number Diff line 
"""

 Dummy Offline



 @results     one result

 @stable      yes

"""





def search(query, request_params):

    return [{

        'result': 'this is what you get',

    }]

searx/engines/genius.py

+1 −0
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ def parse_album(hit): 
            result.update({'content': 'Released: {}'.format(year)})

    return result





parse = {'lyric': parse_lyric, 'song': parse_lyric, 'artist': parse_artist, 'album': parse_album}

searx/preferences.py

+44 −0
Original line number Diff line number Diff line
@@ -104,6 +104,31 @@ class MultipleChoiceSetting(EnumStringSetting): 
        resp.set_cookie(name, ','.join(self.value), max_age=COOKIE_MAX_AGE)





class SetSetting(Setting):

    def _post_init(self):

        if not hasattr(self, 'values'):

            self.values = set()



    def get_value(self):

        return ','.join(self.values)



    def parse(self, data):

        if data == '':

            self.values = set()

            return



        elements = data.split(',')

        for element in elements:

            self.values.add(element)



    def parse_form(self, data):

        elements = data.split(',')

        self.values = set(elements)



    def save(self, name, resp):

        resp.set_cookie(name, ','.join(self.values), max_age=COOKIE_MAX_AGE)





class SearchLanguageSetting(EnumStringSetting):

    """Available choices may change, so user's value may not be in choices anymore"""
@@ -272,6 +297,7 @@ class Preferences(object): 


        self.engines = EnginesSetting('engines', choices=engines)

        self.plugins = PluginsSetting('plugins', choices=plugins)

        self.tokens = SetSetting('tokens')

        self.unknown_params = {}



    def get_as_url_params(self):
@@ -288,6 +314,8 @@ class Preferences(object): 
        settings_kv['disabled_plugins'] = ','.join(self.plugins.disabled)

        settings_kv['enabled_plugins'] = ','.join(self.plugins.enabled)



        settings_kv['tokens'] = ','.join(self.tokens.values)



        return urlsafe_b64encode(compress(urlencode(settings_kv).encode('utf-8'))).decode('utf-8')



    def parse_encoded_data(self, input_data):
@@ -307,6 +335,8 @@ class Preferences(object): 
            elif user_setting_name == 'disabled_plugins':

                self.plugins.parse_cookie((input_data.get('disabled_plugins', ''),

                                           input_data.get('enabled_plugins', '')))

            elif user_setting_name == 'tokens':

                self.tokens.parse(user_setting)

            elif not any(user_setting_name.startswith(x) for x in [

                    'enabled_',

                    'disabled_',
@@ -328,6 +358,8 @@ class Preferences(object): 
                enabled_categories.append(user_setting_name[len('category_'):])

            elif user_setting_name.startswith('plugin_'):

                disabled_plugins.append(user_setting_name)

            elif user_setting_name == 'tokens':

                self.tokens.parse_form(user_setting)

            else:

                self.unknown_params[user_setting_name] = user_setting

        self.key_value_settings['categories'].parse_form(enabled_categories)
@@ -346,6 +378,18 @@ class Preferences(object): 
            user_setting.save(user_setting_name, resp)

        self.engines.save(resp)

        self.plugins.save(resp)

        self.tokens.save('tokens', resp)

        for k, v in self.unknown_params.items():

            resp.set_cookie(k, v, max_age=COOKIE_MAX_AGE)

        return resp



    def validate_token(self, engine):

        valid = True

        if hasattr(engine, 'tokens') and engine.tokens:

            valid = False

            for token in self.tokens.values:

                if token in engine.tokens:

                    valid = True

                    break



        return valid