def simple(facts, start_date, end_date, format, path = None):
facts = copy.deepcopy(facts) # dont want to do anything bad to the input
report_path = stuff.locale_from_utf8(path)
if format == "tsv":
writer = TSVWriter(report_path)
elif format == "xml":
writer = XMLWriter(report_path)
elif format == "ical":
writer = ICalWriter(report_path)
else: #default to HTML
writer = HTMLWriter(report_path, start_date, end_date)
writer.write_report(facts)
# some assembly required - hidden - saved a report for single day
if start_date == end_date:
trophies.unlock("some_assembly_required")
# I want this on my desk - generated over 10 different reports
if trophies.check("on_my_desk") == False:
current = trophies.increment("reports_generated")
if current == 10:
trophies.unlock("on_my_desk")
return writer
def simple(facts, start_date, end_date, format, path=None):
facts = copy.deepcopy(facts) # dont want to do anything bad to the input
report_path = stuff.locale_from_utf8(path)
if format == "tsv":
writer = TSVWriter(report_path)
elif format == "xml":
writer = XMLWriter(report_path)
elif format == "ical":
writer = ICalWriter(report_path)
else: #default to HTML
writer = HTMLWriter(report_path, start_date, end_date)
writer.write_report(facts)
# some assembly required - hidden - saved a report for single day
if start_date == end_date:
trophies.unlock("some_assembly_required")
# I want this on my desk - generated over 10 different reports
if trophies.check("on_my_desk") == False:
current = trophies.increment("reports_generated")
if current == 10:
trophies.unlock("on_my_desk")
return writer
def activity_name_edited_cb(self, cell, path, new_text, model):
id = model[path][0]
category_id = model[path][2]
activities = runtime.storage.get_category_activities(category_id)
prev = None
for activity in activities:
if id == activity['id']:
prev = activity['name']
else:
# avoid two activities in same category with same name
if activity['name'].lower() == new_text.lower():
if id == -1: # that was a new activity
self.activity_store.remove(model.get_iter(path))
self.select_activity(activity['id'])
return False
if id == -1: #new activity -> add
model[path][0] = runtime.storage.add_activity(
new_text, category_id)
else: #existing activity -> update
new = new_text
runtime.storage.update_activity(id, new, category_id)
# size matters - when editing activity name just changed the case (bar -> Bar)
if prev != new and None != prev and prev.lower() == new.lower():
trophies.unlock("size_matters")
model[path][1] = new_text
return True
def _finish(self, facts):
# group by date
by_date = []
for date, date_facts in itertools.groupby(facts,
lambda fact: fact.date):
by_date.append((date, [fact.as_dict() for fact in date_facts]))
by_date = dict(by_date)
date_facts = []
date = min(by_date.keys())
while date <= self.end_date:
str_date = date.strftime(
# date column format for each row in HTML report
# Using python datetime formatting syntax. See:
# http://docs.python.org/library/time.html#time.strftime
C_("html report", "%b %d, %Y"))
date_facts.append([str_date, by_date.get(date, [])])
date += dt.timedelta(days=1)
data = dict(
title=self.title,
totals_by_day_title=_("Totals by Day"),
activity_log_title=_("Activity Log"),
totals_title=_("Totals"),
activity_totals_heading=_("activities"),
category_totals_heading=_("categories"),
tag_totals_heading=_("tags"),
show_prompt=_("Distinguish:"),
header_date=_("Date"),
header_activity=_("Activity"),
header_category=_("Category"),
header_tags=_("Tags"),
header_start=_("Start"),
header_end=_("End"),
header_duration=_("Duration"),
header_description=_("Description"),
data_dir=runtime.data_dir,
show_template=_("Show template"),
template_instructions=
_("You can override it by storing your version in %(home_folder)s")
% {'home_folder': runtime.home_data_dir},
start_date=timegm(self.start_date.timetuple()),
end_date=timegm(self.end_date.timetuple()),
facts=json_dumps([fact.as_dict() for fact in facts]),
date_facts=json_dumps(date_facts),
all_activities_rows="\n".join(self.fact_rows))
for key, val in data.items():
if isinstance(val, str):
data[key] = val
self.file.write(Template(self.main_template).safe_substitute(data))
if self.override:
# my report is better than your report - overrode and ran the default report
trophies.unlock("my_report")
return
def __remove_activity(self, id):
""" check if we have any facts with this activity and behave accordingly
if there are facts - sets activity to deleted = True
else, just remove it"""
query = "select count(*) as count from facts where activity_id = ?"
bound_facts = self.fetchone(query, (id,))['count']
if bound_facts > 0:
self.execute("UPDATE activities SET deleted = 1 WHERE id = ?", (id,))
else:
self.execute("delete from activities where id = ?", (id,))
# Finished! - deleted an activity with more than 50 facts on it
if trophies and bound_facts >= 50:
trophies.unlock("finished")
def __remove_activity(self, id):
""" check if we have any facts with this activity and behave accordingly
if there are facts - sets activity to deleted = True
else, just remove it"""
query = "select count(*) as count from facts where activity_id = ?"
bound_facts = self.fetchone(query, (id,))['count']
if bound_facts > 0:
self.execute("UPDATE activities SET deleted = 1 WHERE id = ?", (id,))
else:
self.execute("delete from activities where id = ?", (id,))
# Finished! - deleted an activity with more than 50 facts on it
if trophies and bound_facts >= 50:
trophies.unlock("finished")
def run_fixtures(self):
self.start_transaction()
"""upgrade DB to hamster version"""
version = self.fetchone("SELECT version FROM version")["version"]
current_version = 9
if version < 8:
# working around sqlite's utf-f case sensitivity (bug 624438)
# more info: http://www.gsak.net/help/hs23820.htm
self.execute(
"ALTER TABLE activities ADD COLUMN search_name varchar2")
activities = self.fetchall("select * from activities")
statement = "update activities set search_name = ? where id = ?"
for activity in activities:
self.execute(statement,
(activity['name'].lower(), activity['id']))
# same for categories
self.execute(
"ALTER TABLE categories ADD COLUMN search_name varchar2")
categories = self.fetchall("select * from categories")
statement = "update categories set search_name = ? where id = ?"
for category in categories:
self.execute(statement,
(category['name'].lower(), category['id']))
if version < 9:
# adding full text search
self.execute("""CREATE VIRTUAL TABLE fact_index
USING fts3(id, name, category, description, tag)"""
)
# at the happy end, update version number
if version < current_version:
#lock down current version
self.execute("UPDATE version SET version = %d" % current_version)
print "updated database from version %d to %d" % (version,
current_version)
# oldtimer – database version structure had been performed on startup (thus we know that user has been on at least 2 versions)
if trophies:
trophies.unlock("oldtimer")
self.end_transaction()
def on_db_file_change(monitor, gio_file, event_uri, event):
if event == gio.FileMonitorEvent.CHANGES_DONE_HINT:
if gio_file.query_info(gio.FILE_ATTRIBUTE_ETAG_VALUE,
gio.FileQueryInfoFlags.NONE,
None).get_etag() == self.__last_etag:
# ours
return
elif event == gio.FileMonitorEvent.CREATED:
# treat case when instead of a move, a remove and create has been performed
self.con = None
if event in (gio.FileMonitorEvent.CHANGES_DONE_HINT, gio.FileMonitorEvent.CREATED):
print "DB file has been modified externally. Calling all stations"
self.dispatch_overwrite()
# plan "b" – synchronize the time tracker's database from external source while the tracker is running
if trophies:
trophies.unlock("plan_b")
def on_db_file_change(monitor, gio_file, event_uri, event):
if event == gio.FileMonitorEvent.CHANGES_DONE_HINT:
if gio_file.query_info(gio.FILE_ATTRIBUTE_ETAG_VALUE,
gio.FileQueryInfoFlags.NONE,
None).get_etag() == self.__last_etag:
# ours
return
elif event == gio.FileMonitorEvent.CREATED:
# treat case when instead of a move, a remove and create has been performed
self.con = None
if event in (gio.FileMonitorEvent.CHANGES_DONE_HINT, gio.FileMonitorEvent.CREATED):
print "DB file has been modified externally. Calling all stations"
self.dispatch_overwrite()
# plan "b" – synchronize the time tracker's database from external source while the tracker is running
if trophies:
trophies.unlock("plan_b")
def run_fixtures(self):
self.start_transaction()
"""upgrade DB to hamster version"""
version = self.fetchone("SELECT version FROM version")["version"]
current_version = 9
if version < 8:
# working around sqlite's utf-f case sensitivity (bug 624438)
# more info: http://www.gsak.net/help/hs23820.htm
self.execute("ALTER TABLE activities ADD COLUMN search_name varchar2")
activities = self.fetchall("select * from activities")
statement = "update activities set search_name = ? where id = ?"
for activity in activities:
self.execute(statement, (activity['name'].lower(), activity['id']))
# same for categories
self.execute("ALTER TABLE categories ADD COLUMN search_name varchar2")
categories = self.fetchall("select * from categories")
statement = "update categories set search_name = ? where id = ?"
for category in categories:
self.execute(statement, (category['name'].lower(), category['id']))
if version < 9:
# adding full text search
self.execute("""CREATE VIRTUAL TABLE fact_index
USING fts3(id, name, category, description, tag)""")
# at the happy end, update version number
if version < current_version:
#lock down current version
self.execute("UPDATE version SET version = %d" % current_version)
print "updated database from version %d to %d" % (version, current_version)
# oldtimer – database version structure had been performed on startup (thus we know that user has been on at least 2 versions)
if trophies:
trophies.unlock("oldtimer")
self.end_transaction()
def on_db_file_change(monitor, gio_file, event_uri, event):
logger.debug(event)
if event == gio.FileMonitorEvent.CHANGES_DONE_HINT:
if gio_file.query_info(
gio.FILE_ATTRIBUTE_ETAG_VALUE,
gio.FileQueryInfoFlags.NONE,
None).get_etag() == self.__last_etag:
# ours
return
elif event == gio.FileMonitorEvent.DELETED:
self.con = None
if event == gio.FileMonitorEvent.CHANGES_DONE_HINT:
print(
"DB file has been modified externally. Calling all stations"
)
self.dispatch_overwrite()
# plan "b" – synchronize the time tracker's database from external source while the tracker is running
if trophies:
trophies.unlock("plan_b")
def __solve_overlaps(self, start_time, end_time):
"""finds facts that happen in given interval and shifts them to
make room for new fact
"""
if end_time is None or start_time is None:
return
# possible combinations and the OR clauses that catch them
# (the side of the number marks if it catches the end or start time)
# |----------------- NEW -----------------|
# |--- old --- 1| |2 --- old --- 1| |2 --- old ---|
# |3 ----------------------- big old ------------------------ 3|
query = """
SELECT a.*, b.name, c.name as category
FROM facts a
LEFT JOIN activities b on b.id = a.activity_id
LEFT JOIN categories c on b.category_id = c.id
WHERE (end_time > ? and end_time < ?)
OR (start_time > ? and start_time < ?)
OR (start_time < ? and end_time > ?)
ORDER BY start_time
"""
conflicts = self.fetchall(
query,
(start_time, end_time, start_time, end_time, start_time, end_time))
for fact in conflicts:
# won't eliminate as it is better to have overlapping entries than loosing data
if start_time < fact["start_time"] and end_time > fact["end_time"]:
continue
# split - truncate until beginning of new entry and create new activity for end
if fact["start_time"] < start_time < fact["end_time"] and \
fact["start_time"] < end_time < fact["end_time"]:
logging.info("splitting %s" % fact["name"])
# truncate until beginning of the new entry
self.execute(
"""UPDATE facts
SET end_time = ?
WHERE id = ?""", (start_time, fact["id"]))
fact_name = fact["name"]
# create new fact for the end
new_fact = Fact(fact["name"],
category=fact["category"],
description=fact["description"])
new_fact_id = self.__add_fact(new_fact.serialized_name(),
end_time, fact["end_time"])
# copy tags
tag_update = """INSERT INTO fact_tags(fact_id, tag_id)
SELECT ?, tag_id
FROM fact_tags
WHERE fact_id = ?"""
self.execute(tag_update,
(new_fact_id, fact["id"])) #clone tags
if trophies:
trophies.unlock("split")
# overlap start
elif start_time < fact["start_time"] < end_time:
logging.info("Overlapping start of %s" % fact["name"])
self.execute("UPDATE facts SET start_time=? WHERE id=?",
(end_time, fact["id"]))
# overlap end
elif start_time < fact["end_time"] < end_time:
logging.info("Overlapping end of %s" % fact["name"])
self.execute("UPDATE facts SET end_time=? WHERE id=?",
(start_time, fact["id"]))
def __add_fact(self, serialized_fact, start_time, end_time = None, temporary = False):
fact = Fact(serialized_fact,
start_time = start_time,
end_time = end_time)
start_time = start_time or fact.start_time
end_time = end_time or fact.end_time
if not fact.activity or start_time is None: # sanity check
return 0
# get tags from database - this will create any missing tags too
tags = [(tag['id'], tag['name'], tag['autocomplete']) for tag in self.get_tag_ids(fact.tags)]
# now check if maybe there is also a category
category_id = None
if fact.category:
category_id = self.__get_category_id(fact.category)
if not category_id:
category_id = self.__add_category(fact.category)
if trophies:
trophies.unlock("no_hands")
# try to find activity, resurrect if not temporary
activity_id = self.__get_activity_by_name(fact.activity,
category_id,
resurrect = not temporary)
if not activity_id:
activity_id = self.__add_activity(fact.activity,
category_id, temporary)
else:
activity_id = activity_id['id']
# if we are working on +/- current day - check the last_activity
if (dt.timedelta(days=-1) <= dt.datetime.now() - start_time <= dt.timedelta(days=1)):
# pull in previous facts
facts = self.__get_todays_facts()
previous = None
if facts and facts[-1]["end_time"] == None:
previous = facts[-1]
if previous and previous['start_time'] <= start_time:
# check if maybe that is the same one, in that case no need to restart
if previous["activity_id"] == activity_id \
and set(previous["tags"]) == set([tag[1] for tag in tags]) \
and (previous["description"] or "") == (fact.description or ""):
return None
# if no description is added
# see if maybe previous was too short to qualify as an activity
if not previous["description"] \
and 60 >= (start_time - previous['start_time']).seconds >= 0:
self.__remove_fact(previous['id'])
# now that we removed the previous one, see if maybe the one
# before that is actually same as the one we want to start
# (glueing)
if len(facts) > 1 and 60 >= (start_time - facts[-2]['end_time']).seconds >= 0:
before = facts[-2]
if before["activity_id"] == activity_id \
and set(before["tags"]) == set([tag[1] for tag in tags]):
# resume and return
update = """
UPDATE facts
SET end_time = null
WHERE id = ?
"""
self.execute(update, (before["id"],))
return before["id"]
else:
# otherwise stop
update = """
UPDATE facts
SET end_time = ?
WHERE id = ?
"""
self.execute(update, (start_time, previous["id"]))
# done with the current activity, now we can solve overlaps
if not end_time:
end_time = self.__squeeze_in(start_time)
else:
self.__solve_overlaps(start_time, end_time)
# finally add the new entry
insert = """
INSERT INTO facts (activity_id, start_time, end_time, description)
VALUES (?, ?, ?, ?)
"""
self.execute(insert, (activity_id, start_time, end_time, fact.description))
fact_id = self.__last_insert_rowid()
#now link tags
insert = ["insert into fact_tags(fact_id, tag_id) values(?, ?)"] * len(tags)
params = [(fact_id, tag[0]) for tag in tags]
self.execute(insert, params)
self.__remove_index([fact_id])
return fact_id
def _finish(self, facts):
# group by date
by_date = []
for date, date_facts in itertools.groupby(facts, lambda fact:fact.date):
by_date.append((date, [dict(fact) for fact in date_facts]))
by_date = dict(by_date)
date_facts = []
date = self.start_date
while date <= self.end_date:
str_date = date.strftime(
# date column format for each row in HTML report
# Using python datetime formatting syntax. See:
# http://docs.python.org/library/time.html#time.strftime
C_("html report","%b %d, %Y"))
date_facts.append([str_date, by_date.get(date, [])])
date += dt.timedelta(days=1)
data = dict(
title = self.title,
totals_by_day_title = _("Totals by Day"),
activity_log_title = _("Activity Log"),
totals_title = _("Totals"),
activity_totals_heading = _("activities"),
category_totals_heading = _("categories"),
tag_totals_heading = _("tags"),
show_prompt = _("Distinguish:"),
header_date = _("Date"),
header_activity = _("Activity"),
header_category = _("Category"),
header_tags = _("Tags"),
header_start = _("Start"),
header_end = _("End"),
header_duration = _("Duration"),
header_description = _("Description"),
data_dir = runtime.data_dir,
show_template = _("Show template"),
template_instructions = _("You can override it by storing your version in %(home_folder)s") % {'home_folder': runtime.home_data_dir},
start_date = timegm(self.start_date.timetuple()),
end_date = timegm(self.end_date.timetuple()),
facts = json_dumps([dict(fact) for fact in facts]),
date_facts = json_dumps(date_facts),
all_activities_rows = "\n".join(self.fact_rows)
)
for key, val in data.iteritems():
if isinstance(val, basestring):
data[key] = val.encode("utf-8")
self.file.write(Template(self.main_template).safe_substitute(data))
if self.override:
# my report is better than your report - overrode and ran the default report
trophies.unlock("my_report")
return
def __add_fact(self,
serialized_fact,
start_time,
end_time=None,
temporary=False):
fact = Fact(serialized_fact, start_time=start_time, end_time=end_time)
start_time = start_time or fact.start_time
end_time = end_time or fact.end_time
if not fact.activity or start_time is None: # sanity check
return 0
# get tags from database - this will create any missing tags too
tags = [(tag['id'], tag['name'], tag['autocomplete'])
for tag in self.get_tag_ids(fact.tags)]
# now check if maybe there is also a category
category_id = None
if fact.category:
category_id = self.__get_category_id(fact.category)
if not category_id:
category_id = self.__add_category(fact.category)
if trophies:
trophies.unlock("no_hands")
# try to find activity, resurrect if not temporary
activity_id = self.__get_activity_by_name(fact.activity,
category_id,
resurrect=not temporary)
if not activity_id:
activity_id = self.__add_activity(fact.activity, category_id,
temporary)
else:
activity_id = activity_id['id']
# if we are working on +/- current day - check the last_activity
if (dt.timedelta(days=-1) <= dt.datetime.now() - start_time <=
dt.timedelta(days=1)):
# pull in previous facts
facts = self.__get_todays_facts()
previous = None
if facts and facts[-1]["end_time"] == None:
previous = facts[-1]
if previous and previous['start_time'] <= start_time:
# check if maybe that is the same one, in that case no need to restart
if previous["activity_id"] == activity_id \
and set(previous["tags"]) == set([tag[1] for tag in tags]) \
and (previous["description"] or "") == (fact.description or ""):
return None
# if no description is added
# see if maybe previous was too short to qualify as an activity
if not previous["description"] \
and 60 >= (start_time - previous['start_time']).seconds >= 0:
self.__remove_fact(previous['id'])
# now that we removed the previous one, see if maybe the one
# before that is actually same as the one we want to start
# (glueing)
if len(facts) > 1 and 60 >= (
start_time - facts[-2]['end_time']).seconds >= 0:
before = facts[-2]
if before["activity_id"] == activity_id \
and set(before["tags"]) == set([tag[1] for tag in tags]):
# resume and return
update = """
UPDATE facts
SET end_time = null
WHERE id = ?
"""
self.execute(update, (before["id"], ))
return before["id"]
else:
# otherwise stop
update = """
UPDATE facts
SET end_time = ?
WHERE id = ?
"""
self.execute(update, (start_time, previous["id"]))
# done with the current activity, now we can solve overlaps
if not end_time:
end_time = self.__squeeze_in(start_time)
else:
self.__solve_overlaps(start_time, end_time)
# finally add the new entry
insert = """
INSERT INTO facts (activity_id, start_time, end_time, description)
VALUES (?, ?, ?, ?)
"""
self.execute(insert,
(activity_id, start_time, end_time, fact.description))
fact_id = self.__last_insert_rowid()
#now link tags
insert = ["insert into fact_tags(fact_id, tag_id) values(?, ?)"
] * len(tags)
params = [(fact_id, tag[0]) for tag in tags]
self.execute(insert, params)
self.__remove_index([fact_id])
return fact_id
def __solve_overlaps(self, start_time, end_time):
"""finds facts that happen in given interval and shifts them to
make room for new fact
"""
if end_time is None or start_time is None:
return
# possible combinations and the OR clauses that catch them
# (the side of the number marks if it catches the end or start time)
# |----------------- NEW -----------------|
# |--- old --- 1| |2 --- old --- 1| |2 --- old ---|
# |3 ----------------------- big old ------------------------ 3|
query = """
SELECT a.*, b.name, c.name as category
FROM facts a
LEFT JOIN activities b on b.id = a.activity_id
LEFT JOIN categories c on b.category_id = c.id
WHERE (end_time > ? and end_time < ?)
OR (start_time > ? and start_time < ?)
OR (start_time < ? and end_time > ?)
ORDER BY start_time
"""
conflicts = self.fetchall(query, (start_time, end_time,
start_time, end_time,
start_time, end_time))
for fact in conflicts:
# won't eliminate as it is better to have overlapping entries than loosing data
if start_time < fact["start_time"] and end_time > fact["end_time"]:
continue
# split - truncate until beginning of new entry and create new activity for end
if fact["start_time"] < start_time < fact["end_time"] and \
fact["start_time"] < end_time < fact["end_time"]:
logging.info("splitting %s" % fact["name"])
# truncate until beginning of the new entry
self.execute("""UPDATE facts
SET end_time = ?
WHERE id = ?""", (start_time, fact["id"]))
fact_name = fact["name"]
# create new fact for the end
new_fact = Fact(fact["name"],
category = fact["category"],
description = fact["description"])
new_fact_id = self.__add_fact(new_fact.serialized_name(), end_time, fact["end_time"])
# copy tags
tag_update = """INSERT INTO fact_tags(fact_id, tag_id)
SELECT ?, tag_id
FROM fact_tags
WHERE fact_id = ?"""
self.execute(tag_update, (new_fact_id, fact["id"])) #clone tags
if trophies:
trophies.unlock("split")
# overlap start
elif start_time < fact["start_time"] < end_time:
logging.info("Overlapping start of %s" % fact["name"])
self.execute("UPDATE facts SET start_time=? WHERE id=?",
(end_time, fact["id"]))
# overlap end
elif start_time < fact["end_time"] < end_time:
logging.info("Overlapping end of %s" % fact["name"])
self.execute("UPDATE facts SET end_time=? WHERE id=?",
(start_time, fact["id"]))
def on_menu_help_contents_activate(self, *args):
gtk.show_uri(gtk.gdk.Screen(), "ghelp:hamster-time-tracker", 0L)
trophies.unlock("basic_instructions")
def on_help_clicked(self, *args):
gtk.show_uri(gtk.gdk.Screen(), "ghelp:hamster-applet", 0L)
trophies.unlock("basic_instructions")
return False
