aboutsummaryrefslogtreecommitdiffstats
path: root/settings.py
blob: 944576d68a716b29dd6b717525840021c283894c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
import ast
import re
import os
import collections

settings_info = collections.OrderedDict([
    ('route_tor', {
        'type': bool,
        'default': False,
        'comment': '',
    }),

    ('port_number', {
        'type': int,
        'default': 8080,
        'comment': '',
    }),

    ('allow_foreign_addresses', {
        'type': bool,
        'default': False,
        'comment': '''This will allow others to connect to your Youtube Local instance as a website.
For security reasons, enabling this is not recommended.''',
    }),

    ('subtitles_mode', {
        'type': int,
        'default': 0,
        'comment': '''0 - off by default
1 - only manually created subtitles on by default
2 - enable even if automatically generated is all that's available''',
    }),

    ('subtitles_language', {
        'type': str,
        'default': 'en',
        'comment': '''ISO 639 language code: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes''',
    }),

    ('related_videos_mode', {
        'type': int,
        'default': 1,
        'comment': '''0 - Related videos disabled
1 - Related videos always shown
2 - Related videos hidden; shown by clicking a button'''
    }),

    ('comments_mode', {
        'type': int,
        'default': 1,
        'comment': '''0 - Video comments disabled
1 - Video comments always shown
2 - Video comments hidden; shown by clicking a button''',
    }),

    ('enable_comment_avatars', {
        'type': bool,
        'default': True,
        'comment': '',
    }),

    ('default_comment_sorting', {
        'type': int,
        'default': 0,
        'comment': '''0 to sort by top
1 to sort by newest''',
    }),

    ('theater_mode', {
        'type': bool,
        'default': True,
        'comment': '',
    }),

    ('default_resolution', {
        'type': int,
        'default': 720,
        'comment': '',
    }),

    ('gather_googlevideo_domains', {
        'type': bool,
        'default': False,
        'comment': '''Developer use to debug 403s''',
    }),

    ('debugging_save_responses', {
        'type': bool,
        'default': False,
        'comment': '''Save all responses from youtube for debugging''',
    }),

    ('settings_version', {
        'type': int,
        'default': 2,
        'comment': '''Do not change, remove, or comment out this value, or else your settings may be lost or corrupted'''
    }),
])

acceptable_targets = settings_info.keys() | {'enable_comments', 'enable_related_videos'}


def comment_string(comment):
    result = ''
    for line in comment.splitlines():
        result += '# ' + line + '\n'
    return result


def create_missing_settings_string(current_settings):
    result = ''
    for setting_name, setting_dict in settings_info.items():
        if setting_name not in current_settings:
            result += comment_string(setting_dict['comment']) + setting_name + ' = ' + repr(setting_dict['default']) + '\n\n'
    return result

def create_default_settings_string():
    return settings_to_string({})

def default_settings():
    return {key: setting_info['default'] for key, setting_info in settings_info.items()}

def settings_to_string(settings):
    '''Given a dictionary with the setting names/setting values for the keys/values, outputs a settings file string.
       Fills in missing values from the defaults.'''
    result = ''
    for setting_name, default_setting_dict in settings_info.items():
        if setting_name in settings:
            value = settings[setting_name]
        else:
            value = default_setting_dict['default']
        result += comment_string(default_setting_dict['comment']) + setting_name + ' = ' + repr(value) + '\n\n'
    return result


def upgrade_to_2(current_settings):
    '''Upgrade to settings version 2'''
    new_settings = current_settings.copy()
    if 'enable_comments' in current_settings:
        new_settings['comments_mode'] = int(current_settings['enable_comments'])
        del new_settings['enable_comments']
    if 'enable_related_videos' in current_settings:
        new_settings['related_videos_mode'] = int(current_settings['enable_related_videos'])
        del new_settings['enable_related_videos']
    return new_settings

def log_ignored_line(line_number, message):
    print("WARNING: Ignoring settings.txt line " + str(node.lineno) + " (" + message + ")")

if os.path.isfile("settings.txt"):
    print("Running in portable mode")
    settings_dir = os.path.normpath('./')
    data_dir = os.path.normpath('./data')
else:
    print("Running in non-portable mode")
    settings_dir = os.path.expanduser(os.path.normpath("~/.youtube-local"))
    data_dir = os.path.expanduser(os.path.normpath("~/.youtube-local/data"))
    if not os.path.exists(settings_dir):
        os.makedirs(settings_dir)

settings_file_path = os.path.join(settings_dir, 'settings.txt')

locals().update(default_settings())

try:
    with open(settings_file_path, 'r', encoding='utf-8') as file:
        settings_text = file.read()
except FileNotFoundError:
    with open(settings_file_path, 'w', encoding='utf-8') as file:
        file.write(create_default_settings_string())
else:
    if re.fullmatch(r'\s*', settings_text):     # blank file
        with open(settings_file_path, 'w', encoding='utf-8') as file:
            file.write(create_default_settings_string())
    else:
        # parse settings in a safe way, without exec
        current_settings = {}
        attributes = {
            ast.NameConstant: 'value',
            ast.Num: 'n',
            ast.Str: 's',
        }
        module_node = ast.parse(settings_text)
        for node in module_node.body:
            if type(node) != ast.Assign:
                log_ignored_line(node.lineno, "only assignments are allowed")
                continue
            
            if len(node.targets) > 1:
                log_ignored_line(node.lineno, "only simple single-variable assignments allowed")
                continue

            target = node.targets[0]
            if type(target) != ast.Name:
                log_ignored_line(node.lineno, "only simple single-variable assignments allowed")
                continue
            
            if target.id not in acceptable_targets:
                log_ignored_line(node.lineno,  target.id + " is not a valid setting")
                continue
            
            if type(node.value) not in (ast.NameConstant, ast.Num, ast.Str):
                log_ignored_line(node.lineno, "only literals allowed for values")
                continue

            current_settings[target.id] = node.value.__getattribute__(attributes[type(node.value)])


        if 'settings_version' not in current_settings:
            print('Upgrading settings.txt')
            new_settings = upgrade_to_2(current_settings)
            locals().update(new_settings)
            new_settings_string = settings_to_string(new_settings)
            with open(settings_file_path, 'w', encoding='utf-8') as file:
                file.write(new_settings_string)

        # some settings not in the file, add those missing settings to the file
        elif len(settings_info.keys() - current_settings.keys()) != 0:
            print('Adding missing settings to settings.txt')
            append_text = create_missing_settings_string(current_settings)
            with open(settings_file_path, 'a', encoding='utf-8') as file:
                file.write('\n\n' + append_text)
            locals().update(current_settings)
        else:
            locals().update(current_settings)




if route_tor:
    print("Tor routing is ON")
else:
    print("Tor routing is OFF - your Youtube activity is NOT anonymous")