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
|
# -*- coding: utf-8 -*-
# -----------------------------------------------------------------------------
# Gettings Things Gnome! - a personal organizer for the GNOME desktop
# Copyright (c) 2008-2012 - Lionel Dricot & Bertrand Rousseau
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program 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 General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
# -----------------------------------------------------------------------------
"""
GTG's core functionality.
In order to not interact directly with the datastore, we provide
"requesters". The requester is only an interface and there can be as
many requesters as you want as long as they are all from the same
datastore. Requester also provides an interface for the tagstore.
If you want to display only a subset of tasks, you can either:
- have access to the main FilteredTree (the one displayed in the main
window) and apply filters on it. (You can create your own)
- get your own personal FilteredTree and apply on it the filters you
want without interfering with the main view. (This is how the closed
tasks pane is built currently)
"""
#=== IMPORT ===================================================================
from configobj import ConfigObj, ConfigObjError
from xdg.BaseDirectory import xdg_data_home, xdg_config_home, xdg_data_dirs
import os
from GTG.tools.borg import Borg
from GTG.tools.testingmode import TestingMode
import GTG
DEFAULTS = {
'browser': {
"bg_color_enable": True,
"contents_preview_enable": False,
'tag_pane': False,
"sidebar_width": 120,
"closed_task_pane": False,
'bottom_pane_position': 300,
'toolbar': True,
'quick_add': True,
'collapsed_tasks': [],
'expanded_tags': [],
'view': 'default',
"opened_tasks": [],
'width': 400,
'height': 400,
'max': False,
'x_pos': 10,
'y_pos': 10,
'tasklist_sort_column': 5,
'tasklist_sort_order': 1,
"font_name": ""
},
'tag_editor': {
"custom_colors": [],
}
}
#Instead of accessing directly the ConfigObj dic, each module will have
#one SubConfig object. (one SubConfig object always match one first level
#element of the ConfigObj directory)
#
#The goal of the SubConfig object is to handle default value and converting
#String to Bool and Int when needed.
#
#Each GTG component using config should be ported to SubConfig and, for each
#setting, a default value should be written in the DEFAULTS above.
#
#Currently done : browser
#Todo : editor, plugins
class SubConfig():
def __init__(self, name, conf_dic):
self.__name = name
self.__conf = conf_dic
if name in DEFAULTS:
self.__defaults = DEFAULTS[name]
else:
self.__defaults = {}
#This return the value of the setting (or the default one)
#
#If a default value exists and is a Int or a Bool, the returned
#value is converted to that type.
def get(self, name):
if name in self.__conf:
toreturn = self.__conf[name]
#Converting to the good type
if name in self.__defaults:
ntype = type(self.__defaults[name])
if ntype in (bool, int) and type(toreturn) == str:
toreturn = eval(toreturn)
elif name in self.__defaults:
toreturn = self.__defaults[name]
self.__conf[name] = toreturn
else:
print "Warning : no default conf value for %s in %s" % (
name, self.__name)
toreturn = None
return toreturn
def set(self, name, value):
self.__conf[name] = str(value)
# Save immediately
self.__conf.parent.write()
def set_lst(self, name, value_lst):
self.__conf[name] = [str(s) for s in value_lst]
# Save immediately
self.__conf.parent.write()
class CoreConfig(Borg):
#The projects and tasks are of course DATA !
#We then use XDG_DATA for them
#Don't forget the "/" at the end.
DATA_FILE = "projects.xml"
CONF_FILE = "gtg.conf"
TASK_CONF_FILE = "tasks.conf"
conf_dict = None
#DBus
BUSNAME = "org.gnome.GTG"
BUSINTERFACE = "/org/gnome/GTG"
#TAGS
ALLTASKS_TAG = "gtg-tags-all"
NOTAG_TAG = "gtg-tags-none"
SEP_TAG = "gtg-tags-sep"
SEARCH_TAG = "search"
def check_config_file(self,file_path):
""" This function bypasses the errors of config file and allows GTG to open smoothly"""
total_path=self.conf_dir+file_path
try:
config = ConfigObj(total_path)
except ConfigObjError:
open(total_path, "w").close()
config = ConfigObj(total_path)
return config
def __init__(self):
if hasattr(self, 'data_dir'):
#Borg has already been initialized
return
if TestingMode().get_testing_mode():
#we avoid running tests in the user data dir
self.data_dir = '/tmp/GTG_TESTS/data'
self.conf_dir = '/tmp/GTG_TESTS/conf'
else:
self.data_dir = os.path.join(xdg_data_home, 'gtg/')
self.conf_dir = os.path.join(xdg_config_home, 'gtg/')
if not os.path.exists(self.conf_dir):
os.makedirs(self.conf_dir)
if not os.path.exists(self.data_dir):
os.makedirs(self.data_dir)
if not os.path.exists(self.conf_dir + self.CONF_FILE):
open(self.conf_dir + self.CONF_FILE, "w").close()
if not os.path.exists(self.conf_dir + self.TASK_CONF_FILE):
open(self.conf_dir + self.TASK_CONF_FILE, "w").close()
for conf_file in [self.conf_dir + self.CONF_FILE,
self.conf_dir + self.TASK_CONF_FILE]:
if not os.access(conf_file, os.R_OK | os.W_OK):
raise Exception("File " + file + \
" is a configuration file for gtg, but it "
"cannot be read or written. Please check it")
self.conf_dict = self.check_config_file(self.CONF_FILE)
self.task_conf_dict = self.check_config_file(self.TASK_CONF_FILE)
def save(self):
''' Saves the configuration of CoreConfig '''
self.conf_dict.write()
self.task_conf_dict.write()
def get_subconfig(self, name):
if not name in self.conf_dict:
self.conf_dict[name] = {}
return SubConfig(name, self.conf_dict[name])
def get_icons_directories(self):
""" Returns the directories containing the icons """
icons_dirs = [os.path.join(dir, 'gtg/icons') for dir in xdg_data_dirs]
icons_dirs.append(os.path.join(GTG.DATA_DIR, "icons"))
icons_dirs.append(GTG.DATA_DIR)
return icons_dirs
def get_data_dir(self):
return self.data_dir
def set_data_dir(self, path):
self.data_dir = path
def get_conf_dir(self):
return self.conf_dir
def set_conf_dir(self, path):
self.conf_dir = path
|