# # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2007 Thom Sturgill # Copyright (C) 2007-2009 Brian G. Matherly # Copyright (C) 2008-2009 Rob G. Healey # Copyright (C) 2008 Jason Simanek # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Pubilc License as published by # the Free Software Foundation; either version 2 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, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # $Id$ """ Web Calendar generator. Refactoring. This is an ongoing job until this plugin is in a better shape. TODO list: - progress bar, rethink its usage - in year navigation, use month in link, or 'fullyear' - daylight saving not just for USA and Europe - move the close_file() from one_day() to caller """ #------------------------------------------------------------------------ # # python modules # #------------------------------------------------------------------------ import os import time import datetime import calendar import codecs import shutil from gettext import gettext as _ from gettext import ngettext #------------------------------------------------------------------------ # # Set up logging # #------------------------------------------------------------------------ import logging log = logging.getLogger(".WebPage") #------------------------------------------------------------------------ # # GRAMPS module # #------------------------------------------------------------------------ import gen.lib import const from GrampsCfg import get_researcher from gen.plug import PluginManager from ReportBase import Report, ReportUtils, MenuReportOptions, CATEGORY_WEB from gen.plug.menu import BooleanOption, NumberOption, StringOption, \ EnumeratedListOption, FilterOption, PersonOption, \ DestinationOption import Utils import GrampsLocale from QuestionDialog import WarningDialog from Utils import probably_alive from DateHandler import displayer as _dd from DateHandler import parser as _dp import libholiday #------------------------------------------------------------------------ # # constants # #------------------------------------------------------------------------ # This information defines the list of styles in the Web calendar # options dialog as well as the location of the corresponding SCREEN # stylesheets. _CSS_FILES = [ # First is used as default selection. [_("Basic-Ash"), 'Web_Basic-Ash.css'], [_("Basic-Cypress"), 'Web_Basic-Cypress.css'], [_("Basic-Lilac"), 'Web_Basic-Lilac.css'], [_("Basic-Peach"), 'Web_Basic-Peach.css'], [_("Basic-Spruce"), 'Web_Basic-Spruce.css'], [_("Mainz"), 'Web_Mainz.css'], [_("Nebraska"), 'Web_Nebraska.css'], [_("Visually Impaired"), 'Web_Visually.css'], [_("No style sheet"), ''], ] _CHARACTER_SETS = [ # First is used as default selection. [_('Unicode (recommended)'), 'utf-8'], ['ISO-8859-1', 'iso-8859-1' ], ['ISO-8859-2', 'iso-8859-2' ], ['ISO-8859-3', 'iso-8859-3' ], ['ISO-8859-4', 'iso-8859-4' ], ['ISO-8859-5', 'iso-8859-5' ], ['ISO-8859-6', 'iso-8859-6' ], ['ISO-8859-7', 'iso-8859-7' ], ['ISO-8859-8', 'iso-8859-8' ], ['ISO-8859-9', 'iso-8859-9' ], ['ISO-8859-10', 'iso-8859-10' ], ['ISO-8859-13', 'iso-8859-13' ], ['ISO-8859-14', 'iso-8859-14' ], ['ISO-8859-15', 'iso-8859-15' ], ['koi8_r', 'koi8_r', ], ] _CC = [ '', '' 'Creative Commons License - By attribution', '' 'Creative Commons License - By attribution, No derivations', '' 'Creative Commons License - By attribution, Share-alike', '' 'Creative Commons License - By attribution, Non-commercial', '' 'Creative Commons License - By attribution, Non-commercial, No derivations', '' 'Creative Commons License - By attribution, Non-commerical, Share-alike' ] _COPY_OPTIONS = [ _('Standard copyright'), # This must match _CC _('Creative Commons - By attribution'), _('Creative Commons - By attribution, No derivations'), _('Creative Commons - By attribution, Share-alike'), _('Creative Commons - By attribution, Non-commercial'), _('Creative Commons - By attribution, Non-commercial, No derivations'), _('Creative Commons - By attribution, Non-commercial, Share-alike'), _('No copyright notice'), ] #------------------------------------------------------------------------ # # WebCalReport # #------------------------------------------------------------------------ class WebCalReport(Report): """ Create WebCalReport object that produces the report. """ def __init__(self, database, options): Report.__init__(self, database, options) menu = options.menu self.database = database self.options = options self.html_dir = menu.get_option_by_name('target').get_value() self.title_text = menu.get_option_by_name('title').get_value() filter_option = menu.get_option_by_name('filter') self.filter = filter_option.get_filter() self.ext = menu.get_option_by_name('ext').get_value() self.copy = menu.get_option_by_name('cright').get_value() self.encoding = menu.get_option_by_name('encoding').get_value() self.css = menu.get_option_by_name('css').get_value() self.country = menu.get_option_by_name('country').get_value() self.start_dow = menu.get_option_by_name('start_dow').get_value() self.multiyear = menu.get_option_by_name('multiyear').get_value() self.start_year = menu.get_option_by_name('start_year').get_value() self.end_year = menu.get_option_by_name('end_year').get_value() self.fullyear = menu.get_option_by_name('fullyear').get_value() self.maiden_name = menu.get_option_by_name('maiden_name').get_value() self.alive = menu.get_option_by_name('alive').get_value() self.birthday = menu.get_option_by_name('birthdays').get_value() self.anniv = menu.get_option_by_name('anniversaries').get_value() self.home_link = menu.get_option_by_name('home_link').get_value().strip() self.month_notes = [menu.get_option_by_name('note_jan').get_value(), menu.get_option_by_name('note_feb').get_value(), menu.get_option_by_name('note_mar').get_value(), menu.get_option_by_name('note_apr').get_value(), menu.get_option_by_name('note_may').get_value(), menu.get_option_by_name('note_jun').get_value(), menu.get_option_by_name('note_jul').get_value(), menu.get_option_by_name('note_aug').get_value(), menu.get_option_by_name('note_sep').get_value(), menu.get_option_by_name('note_oct').get_value(), menu.get_option_by_name('note_nov').get_value(), menu.get_option_by_name('note_dec').get_value()] # identify researcher name and e-mail address # as Narrated WebSite already does researcher = get_researcher() self.author = researcher.name if self.author: self.author = self.author.replace(',,,', '') self.email = researcher.email today = time.localtime() # set to today's date self.today = datetime.date(today[0], today[1], today[2]) self.warn_dir = True # Only give warning once. # self.calendar is a dict; key is the month number # Each entry in the dict is also a dict; key is the day number. # The day dict is a list of things to display for that day. # These things are: birthdays and anniversaries self.calendar = {} calendar.setfirstweekday(dow_gramps2iso[self.start_dow]) def copy_file(self, from_fname, to_fname, to_dir=''): """ Copy a file from a source to a (report) destination. If to_dir is not present and if the target is not an archive, then the destination directory will be created. Normally 'to_fname' will be just a filename, without directory path. 'to_dir' is the relative path name in the destination root. It will be prepended before 'to_fname'. """ dest = os.path.join(self.html_dir, to_dir, to_fname) destdir = os.path.dirname(dest) if not os.path.isdir(destdir): os.makedirs(destdir) if from_fname != dest: shutil.copyfile(from_fname, dest) elif self.warn_dir: WarningDialog( _("Possible destination error") + "\n" + _("You appear to have set your target directory " "to a directory used for data storage. This " "could create problems with file management. " "It is recommended that you consider using " "a different directory to store your generated " "web pages.")) self.warn_dir = False def add_day_item(self, text, year, month, day, event): if day == 0: # This may happen for certain "about" dates. day = 1 # Use first day of the month month_dict = self.calendar.get(month, {}) day_list = month_dict.get(day, []) if month > 0: try: event_date = gen.lib.Date() event_date.set_yr_mon_day(year, month, day) except ValueError: event_date = '...' else: event_date = '...' #Incomplete date as in about, circa, etc. day_list.append((text, event, event_date)) month_dict[day] = day_list self.calendar[month] = month_dict def __get_holidays(self, year): """ Get the holidays for the specified country and year """ holiday_table = libholiday.HolidayTable() country = holiday_table.get_countries()[self.country] holiday_table.load_holidays(year, country) for month in range(1, 13): for day in range(1, 32): holiday_names = holiday_table.get_holidays(month, day) for holiday_name in holiday_names: self.add_holiday_item(holiday_name, month, day) def add_holiday_item(self, text, month, day): """ add holiday to its dictionary text -- holiday title month -- month of holiday day -- day of holiday """ if day == 0: # This may happen for certain "about" dates. day = 1 # Use first day of the month month_dict = self.holidays.get(month, {}) day_list = month_dict.get(day, []) day_list.append(text) month_dict[day] = day_list self.holidays[month] = month_dict def copy_calendar_files(self): """ Copies all the necessary stylesheets and images for these calendars """ # Copy the screen stylesheet if self.css: fname = os.path.join(const.DATA_DIR, self.css) self.copy_file(fname, self.css, "styles") # copy print stylesheet fname = os.path.join(const.DATA_DIR, "Web_Print-Default.css") self.copy_file(fname, "Web_Print-Default.css", "styles") # set imgs to empty imgs = [] if self.css == "Web_Mainz.css": # Copy Mainz Style Images imgs += ["Web_Mainz_Bkgd.png", "Web_Mainz_Header.png", "Web_Mainz_Mid.png", "Web_Mainz_MidLight.png", ] # Copy GRAMPS favicon imgs += ['favicon.ico'] # copy copyright image if 0 < self.copy < len(_CC): imgs += ['somerights20.gif'] for fname in imgs: from_path = os.path.join(const.IMAGE_DIR, fname) self.copy_file(from_path, fname, "images") def display_month_navs(self, of, nr_up, year, currentsection, use_home): """ Will create and display the navigation menu bar use_home will produce a link to wherever you specify as a home link of = calendar filename being created nr_up = number of directories up to reach root directory year = year being created currentsection = month name being created for proper CSS styling use_home = if creating a link to home -- a link to root directory of website """ navs = [] # check to see if we are using a home link??? if use_home: navs.append((self.home_link, _('Home'), True)) for month in range(1, 13): navs.append((month, month, True)) # Add a link for year_glance() if requested navs.append(('fullyear', _('Year Glance'), self.fullyear)) of.write('\n\n') def display_year_navs(self, of, nr_up, currentsection): """ This will create the year navigation menu bar of = current calendar filename being created nr_up = number of directories up to reach root directory currentsection = proper styling of this navigation bar """ # creating more than one year if not self.multiyear: return num_years = (self.end_year - self.start_year) cal_year = self.start_year nrows = (num_years / 16) for rows in range(0, (nrows + 1)): of.write('\n') def calendar_common(self, of, nr_up, year, currentsection, title, use_home=False): """ Will create the common information for each calendar being created of = current filename being created, can be either web_cal(), or year_glance() nr_up = number of directories up to reach root directory/ self.html_dir year = year being created currentsection = current section for proper styling of display_month_navs() title = title for this calendar use_home = for display_month_navs() to display a link to home -- home directory of website """ # Header Title of.write('\n' % msg) if self.multiyear: # create Year Navigation menu self.display_year_navs(of, nr_up, str(year)) # Create Month Navigation Menu # identify currentsection for proper highlighting self.display_month_navs(of, nr_up, year, currentsection, use_home) of.write('
\n') def calendar_build(self, of, cal, year, month): """ This does the work of building the calendar 'cal' - one of "yg", or "wc" yg = year_glance() wc = web_cal() 'year' -- year being created 'month' - month number 1, 2, .., 12 """ # define names for long and short month names full_month_name = get_full_month_name(month) abbr_month_name = get_short_month_name(month) # dow (day-of-week) uses Gramps numbering, sunday => 1, etc start_dow = self.start_dow col2day = [(x-1)%7+1 for x in range(start_dow, start_dow + 7)] def get_class_for_daycol(col): """ Translate a Gramps day number into a HTMLclass """ day = col2day[col] if day == 1: return "weekend sunday" elif day == 7: return "weekend saturday" return "weekday" def get_name_for_daycol(col): """ Translate a Gramps day number into a HTMLclass """ day = col2day[col] return day_names[day] # Note. GrampsLocale has sunday => 1, monday => 2, etc # We slice out the first empty element. day_names = GrampsLocale.long_days # Begin calendar head. We'll use the capitalized name, because here it # seems appropriate for most countries. month_name = full_month_name.capitalize() th_txt = month_name if cal == 'wc': # web_cal() if not self.multiyear: th_txt = '%s %d' % (month_name, year) of.write('\n\n' % month_name) of.write('\n' % month_name) of.write('\t\n') of.write('\t\t\n') of.write('\t\t\t\n' % th_txt) of.write('\t\t\n') # Calendar weekday names header of.write('\t\t\n') for day_col in range(7): dayclass = get_class_for_daycol(day_col) dayname = get_name_for_daycol(day_col) of.write('\t\t\t\n' % dayname[0]) of.write('\t\t\n') of.write('\t\n') # begin table body of.write('\t\n') # get first of the month and month information current_date, current_ord, monthinfo = get_first_day_of_month(year, month) nweeks = len(monthinfo) for week_row in range(0, nweeks): week = monthinfo[week_row] # if you look this up in wikipedia, the first week is called week0 of.write('\t\t\n' % week_row) for day_col in range(0, 7): dayclass = get_class_for_daycol(day_col) day = week[day_col] if day == 0: # a day in the previous or next month if week_row == 0: # a day in the previous month specday = get_previous_day(year, month, day_col) specclass = "previous " + dayclass elif week_row == nweeks-1: # a day in the next month specday = get_next_day(year, month, day_col) specclass = "next " + dayclass of.write('\t\t\t\n') else: # normal day number in current month thisday = datetime.date.fromordinal(current_ord) of.write('\t\t\t\n') # change day number current_ord += 1 # close the week/ row of.write('\t\t\n') if cal == "yg": # Fill up till we have 6 rows, so that the months align properly for i in range(nweeks, 6): of.write('\t\t\n' % (i+1)) of.write('\t\t\t\n') of.write('\t\t\n') # close table body of.write('\t\n') def write_header(self, of, nr_up, title, add_print=True): """ This creates the header for the Calendars including style embedded for special purpose 'nr_up' - number of directory levels up, started from current page, to the root of the directory tree (i.e. to self.html_dir). """ of.write('\n') xmllang = Utils.xml_lang() of.write('\n' % (xmllang, xmllang)) of.write('\n') of.write('\t%s\n\n' % title) of.write('\t\n' % self.encoding) of.write('\t\n' % (const.PROGRAM_NAME, const.VERSION, const.URL_HOMEPAGE)) of.write('\t\n\n' % self.author) subdirs = ['..'] * nr_up # link to screen stylesheet fname = '/'.join(subdirs + ['styles'] + [self.css]) of.write('\t\n') # link to print stylesheet if add_print: fname = '/'.join(subdirs + ['styles'] + ["Web_Print-Default.css"]) of.write('\t\n') # link to GRAMPS favicon fname = '/'.join(subdirs + ['images'] + ['favicon.ico']) of.write('\t\n') of.write('\n\n') def write_footer(self, of, nr_up): """ Writes the footer section of the pages 'nr_up' - number of directory levels up, started from current page, to the root of the directory tree (i.e. to self.html_dir). """ of.write('
\n') of.write('\n') # Closing "content" of.write('\n') of.write('\n') of.write('\n') def create_file(self, fname, subdir): """ Create a file in the html_dir tree. If the directory does not exist, create it. """ fname = os.path.join(self.html_dir, subdir, fname) if not fname.endswith(self.ext): fname += self.ext destdir = os.path.dirname(fname) if not os.path.isdir(destdir): os.makedirs(destdir) of = codecs.EncodedFile(open(fname, "w"), 'utf-8', self.encoding, 'xmlcharrefreplace') return of def close_file(self, of): """ will close whatever filename is passed to it """ of.close() def one_day(self, of, event_date, one_day_cal, day_list): """ This method creates the One Day page for "Year At A Glance" event_date -- date for this file and events one_day_cal -- either year_glance() or WebCal() day_list - a combination of both dictionaries to be able to create one day nyears, date, text, event --- are necessary for figuring the age or years married for each year being created... """ # This is one_day in the year-at-a-glance calendar if one_day_cal == "OneDay": # break up event_date to get year, month, day for this day year = event_date.get_year() month = event_date.get_month() day = event_date.get_day() # create fname date string for "One Day" calendar pages filename # using yyyymmdd for filename two_digit_month = '%02d' % month two_digit_day = '%02d' % day fname_date = str(year) + str(two_digit_month) + str(two_digit_day) # define name for long month full_month_name = get_full_month_name(month) # Name the file, and create it (see code in calendar_build) fpath = os.path.join(str(year), full_month_name) of = self.create_file(fname_date, fpath) nr_up = 2 # number of directory levels up to get to root # set date display as in user prevferences pg_date = _dd.display(event_date) # page title title = _('One Day Within A Year') # Add Header self.write_header(of, nr_up, title, False) of.write('\n' % pg_date) self.calendar_common(of, nr_up, year, full_month_name, title) of.write('\t

%s

\n' % pg_date) #of = of # because of two different fnames needing # to access this variable # for both "WebCal" and "One Day" of.write('\t\t\t\t\t\n') # if calendar is one_day(), write_footer() and close_file() if one_day_cal == "OneDay": self.write_footer(of, nr_up) self.close_file(of) def year_glance(self, year): """ This method will create the Full Year At A Glance Page... year -- year being created """ nr_up = 1 # Number of directory levels up to get to root # Name the file, and create it of = self.create_file('fullyear', str(year)) # page title title = _("%(year)d, At A Glance") % {'year' : year} # Add Header self.write_header(of, nr_up, title, False) of.write('\n') self.calendar_common(of, nr_up, year, 'fullyear', title) # page description of.write('
\n') msg = (_('This calendar is meant to give you access ' 'to all your data at a glance compressed into one page. Clicking ' 'on a date will take you to a page that shows all the events for ' 'that date, if there are any!\n')) of.write('

%s

\n' % msg) # generate progress pass for "Year At A Glance" self.progress.set_pass(_('Creating Year At A Glance calendars'), 12) for month in range(1, 13): # build the calendar self.calendar_build(of, "yg", year, month) # create note section for "Year At A Glance" note = self.month_notes[month-1].strip() note = note or " " of.write('\t\n') of.write('\t\t\n') of.write('\t\t\t\n' % note) of.write('\t\t\n') of.write('\t\n') of.write('
%s
\n' % (dayclass, dayname)) of.write('\t\t\t\t%s
\n' % specclass) of.write('\t\t\t\t
%d
\n' % specday) of.write('\t\t\t		 [] or bday_anniv_list > []: hilightday = 'highlight ' + dayclass # specify day class for this day of.write('class="%s">\n' % hilightday) event_date = gen.lib.Date() event_date.set_yr_mon_day(thisday.year, thisday.month, thisday.day) day_list = get_day_list(event_date, holiday_list, bday_anniv_list) if day_list: # Year at a Glance if cal == "yg": # create yyyymmdd date string for # "One Day" calendar page filename two_digit_month = '%02d' % month two_digit_day = '%02d' % day fname_date = str(year) + str(two_digit_month) \ + str(two_digit_day) # create web link to corresponding # "One Day" page... # The HREF is relative to the year path. fname_date = '/'.join([full_month_name, fname_date]) fname_date += self.ext of.write('\t\t\t\t\n' % (fname_date, abbr_month_name, day)) of.write('\t\t\t\t\t
' '%d
\n' % day) one_day_cal = "OneDay" # WebCal else: one_day_cal = "WebCal" of.write('\t\t\t\t
' '%d
\n' % day) # both WebCal and Year_Glance needs # day_list displayed self.one_day(of, event_date, one_day_cal, day_list) # no holiday/ bday/ anniversary this day else: of.write('class="%s">\n' % dayclass) of.write('\t\t\t\t
' '%d
\n' % day) # no holiday/ bday/ anniversary this month else: of.write('class="%s">\n' % dayclass) of.write('\t\t\t\t
' '%d
\n' % day) # close the day/ column of.write('\t\t\t
%s
\n\n') # increase progress bar self.progress.step() # write footer section, and close file self.write_footer(of, nr_up) self.close_file(of) def write_report(self): """ The short method that runs through each month and creates a page. """ # open progress meter bar self.progress = Utils.ProgressMeter(_("Web Calendar Report"), '') # get data from database for birthdays/ anniversaries self.collect_data(self.start_year) # Copy all files for the calendars being created self.copy_calendar_files() if self.multiyear: for cal_year in range(self.start_year, (self.end_year + 1)): # generate progress pass for year ???? self.progress.set_pass(_('Creating year %d calendars') % cal_year, 1) # initialize the holidays dict to fill: self.holidays = {} # get the information, first from holidays: if self.country != 0: self.__get_holidays(cal_year) # create "WebCal" calendar pages self.web_cal(cal_year) # create "Year At A Glance" and "One Day" calendar pages if self.fullyear: self.year_glance(cal_year) # a single year else: cal_year = self.start_year self.holidays = {} # get the information, first from holidays: if self.country != 0: self.__get_holidays(cal_year) # create "WebCal" calendar pages self.web_cal(cal_year) # create "Year At A Glance" if self.fullyear: self.year_glance(cal_year) # Close the progress meter self.progress.close() def web_cal(self, year): """ This method provides information and header/ footer to the calendar month year -- year being created """ # do some error correcting if needed if self.multiyear: if self.end_year < self.start_year: # Huh? Why start_year+1? self.end_year = self.start_year + 1 nr_up = 1 # Number of directory levels up to get to self.html_dir / root # generate progress pass for "WebCal" self.progress.set_pass(_('Formatting months ...'), 12) for month in range(1, 13): # Name the file, and create it cal_fname = get_full_month_name(month) of = self.create_file(cal_fname, str(year)) # Add Header self.write_header(of, nr_up, self.title_text, True) of.write('\n') self.calendar_common(of, nr_up, year, cal_fname, self.title_text, True) # build the calendar self.calendar_build(of, "wc", year, month) # create note section for "WebCal" note = self.month_notes[month-1].strip() note = note or " " of.write('\t\n') of.write('\t\t\n') of.write('\t\t\t%s\n' % note) of.write('\t\t\n') of.write('\t\n') of.write('\n\n') # write footer section, and close file self.write_footer(of, nr_up) self.close_file(of) # increase progress bar self.progress.step() def collect_data(self, this_year): """ This method runs through the data, and collects the relevant dates and text. """ people = self.database.get_person_handles(sort_handles=False) self.progress.set_pass(_('Applying Filter...'), len(people)) people = self.filter.apply(self.database, people, self.progress) self.progress.set_pass(_("Reading database..."), len(people)) for person_handle in people: self.progress.step() person = self.database.get_person_from_handle(person_handle) family_list = person.get_family_handle_list() birth_ref = person.get_birth_ref() birth_date = None if birth_ref: birth_event = self.database.get_event_from_handle(birth_ref.ref) birth_date = birth_event.get_date_object() # determine birthday information??? if self.birthday and birth_date is not None: # determine if birthdadate is a valid date??? complete_date = False if birth_date.is_valid(): complete_date = True if complete_date: year = birth_date.get_year() month = birth_date.get_month() day = birth_date.get_day() prob_alive_date = gen.lib.Date(this_year, month, day) # add some things to handle maiden name: father_surname = None # husband, actually sex = person.gender if sex == gen.lib.Person.FEMALE: # get husband's last name: if self.maiden_name in ['spouse_first', 'spouse_last']: if len(family_list) > 0: if self.maiden_name == 'spouse_first': fhandle = family_list[0] else: fhandle = family_list[-1] fam = self.database.get_family_from_handle(fhandle) father_handle = fam.get_father_handle() mother_handle = fam.get_mother_handle() if mother_handle == person_handle: if father_handle: father = self.database.get_person_from_handle(father_handle) if father != None: father_name = father.primary_name father_surname = _get_regular_surname(sex, father_name) short_name = _get_short_name(person, father_surname) alive = probably_alive(person, self.database, prob_alive_date) text = _('%(short_name)s') % {'short_name' : short_name} if (self.alive and alive) or not self.alive: self.add_day_item(text, year, month, day, 'Birthday') # add anniversary if requested if self.anniv: for fhandle in family_list: fam = self.database.get_family_from_handle(fhandle) father_handle = fam.get_father_handle() mother_handle = fam.get_mother_handle() if father_handle == person.handle: spouse_handle = mother_handle else: continue # with next person if this was the marriage event if spouse_handle: spouse = self.database.get_person_from_handle(spouse_handle) if spouse: spouse_name = _get_short_name(spouse) short_name = _get_short_name(person) are_married = get_marrital_status(self.database, fam) if are_married is not None: for event_ref in fam.get_event_ref_list(): event = self.database.get_event_from_handle(event_ref.ref) event_obj = event.get_date_object() year = event_obj.get_year() month = event_obj.get_month() day = event_obj.get_day() prob_alive_date = gen.lib.Date(this_year, month, day) # determine if anniversary date is a valid date??? complete_date = False if event_obj.is_valid(): complete_date = True if complete_date: text = _('%(spouse)s and %(person)s') % { 'spouse' : spouse_name, 'person' : short_name} alive1 = probably_alive(person, self.database, prob_alive_date) alive2 = probably_alive(spouse, self.database, prob_alive_date) if ((self.alive and alive1 and alive2) or not self.alive): self.add_day_item(text, year, month, day, 'Anniversary') #------------------------------------------------------------------------ # # WebCalOptions # #------------------------------------------------------------------------ class WebCalOptions(MenuReportOptions): """ Defines options and provides handling interface. """ def __init__(self, name, dbase): self.__db = dbase self.__pid = None self.__filter = None MenuReportOptions.__init__(self, name, dbase) def add_menu_options(self, menu): """ Add options to the menu for the web calendar. """ self.__add_report_options(menu) self.__add_content_options(menu) self.__add_notes_options(menu) def __add_report_options(self, menu): """ Options on the "Report Options" tab. """ category_name = _("Report Options") target = DestinationOption( _("Destination"), os.path.join(const.USER_HOME, "WEBCAL")) target.set_help( _("The destination directory for the web files")) target.set_directory_entry(True) menu.add_option(category_name, "target", target) title = StringOption(_('Calendar Title'), _('My Family Calendar')) title.set_help(_("The title of the calendar")) menu.add_option(category_name, "title", title) self.__filter = FilterOption(_("Filter"), 0) self.__filter.set_help( _("Select filter to restrict people that appear on calendar")) menu.add_option(category_name, "filter", self.__filter) self.__filter.connect('value-changed', self.__filter_changed) self.__pid = PersonOption(_("Filter Person")) self.__pid.set_help(_("The center person for the filter")) menu.add_option(category_name, "pid", self.__pid) self.__pid.connect('value-changed', self.__update_filters) self.__update_filters() ext = EnumeratedListOption(_("File extension"), ".html" ) for etype in ['.html', '.htm', '.shtml', '.php', '.php3', '.cgi']: ext.add_item(etype, etype) ext.set_help( _("The extension to be used for the web files")) menu.add_option(category_name, "ext", ext) cright = EnumeratedListOption(_('Copyright'), 0 ) for index, copt in enumerate(_COPY_OPTIONS): cright.add_item(index, copt) cright.set_help( _("The copyright to be used for the web files")) menu.add_option(category_name, "cright", cright) encoding = EnumeratedListOption(_('Character set encoding'), \ _CHARACTER_SETS[0][1]) for eopt in _CHARACTER_SETS: encoding.add_item(eopt[1], eopt[0]) encoding.set_help( _('The encoding to be used for ' 'the web files')) menu.add_option(category_name, "encoding", encoding) css = EnumeratedListOption(_('StyleSheet'), \ _CSS_FILES[0][1]) for style in _CSS_FILES: css.add_item(style[1], style[0]) css.set_help( _('The Style Sheet to be used ' 'for the web page')) menu.add_option(category_name, "css", css) def __add_content_options(self, menu): """ Options on the "Content Options" tab. """ category_name = _("Content Options") # set to today's date for use in menu, etc. # 0 = year, 1 = month, 2 = day today = time.localtime() today = datetime.date(today[0], today[1], today[2]) self.__multiyear = BooleanOption(_('Create multiple year ' 'calendars'), False) self.__multiyear.set_help(_('Whether to create Multiple year ' 'calendars or not.')) menu.add_option(category_name, 'multiyear', self.__multiyear) self.__multiyear.connect('value-changed', self.__multiyear_changed) self.__start_year = NumberOption(_('Start Year for the ' 'Calendar(s)'), today.year, 1900, 3000) self.__start_year.set_help(_('Enter the starting year for the calendars ' 'between 1900 - 3000')) menu.add_option(category_name, 'start_year', self.__start_year) self.__end_year = NumberOption(_('End Year for the ' 'Calendar(s)'), today.year, 1900, 3000) self.__end_year.set_help(_('Enter the ending year for the calendars ' 'between 1900 - 3000. if multiple years ' 'is selected, then only twenty years at any ' 'given time')) menu.add_option(category_name, 'end_year', self.__end_year) self.__multiyear_changed() fullyear = BooleanOption(_('Create "Year At A Glance" ' 'Calendar(s)'), False) fullyear.set_help(_('Whether to create A one-page mini calendar ' 'with dates highlighted')) menu.add_option(category_name, 'fullyear', fullyear) country = EnumeratedListOption(_('Country for holidays'), 0 ) holiday_table = libholiday.HolidayTable() for index, item in enumerate(holiday_table.get_countries()): country.add_item(index, item) country.set_help(_("Holidays will be included for the selected " "country")) menu.add_option(category_name, "country", country) maiden_name = EnumeratedListOption(_("Birthday surname"), "own") maiden_name.add_item('spouse_first', _("Wives use husband's surname " "(from first family listed)")) maiden_name.add_item('spouse_last', _("Wives use husband's surname " "(from last family listed)")) maiden_name.add_item("own", _("Wives use their own surname")) maiden_name.set_help(_("Select married women's displayed surname")) menu.add_option(category_name, "maiden_name", maiden_name) # Default selection ???? start_dow = EnumeratedListOption(_("First day of week"), 1) for count in range(1, 8): start_dow.add_item(count, GrampsLocale.long_days[count].capitalize()) start_dow.set_help(_("Select the first day of the week for the calendar")) menu.add_option(category_name, "start_dow", start_dow) home_link = StringOption(_('Home link'), '../index.html') home_link.set_help(_("The link to be included to direct the user to " "the main page of the web site")) menu.add_option(category_name, "home_link", home_link) alive = BooleanOption(_("Include only living people"), True) alive.set_help(_("Include only living people in the calendar")) menu.add_option(category_name, "alive", alive) birthdays = BooleanOption(_("Include birthdays"), True) birthdays.set_help(_("Include birthdays in the calendar")) menu.add_option(category_name, "birthdays", birthdays) anniversaries = BooleanOption(_("Include anniversaries"), True) anniversaries.set_help(_("Include anniversaries in the calendar")) menu.add_option(category_name, "anniversaries", anniversaries) def __add_notes_options(self, menu): """ Options on the "Months Notes" tabs. """ category_name = _("Jan - Jun Notes") note_jan = StringOption(_('Jan Note'), _('This prints in January')) note_jan.set_help(_("The note for the month of January")) menu.add_option(category_name, "note_jan", note_jan) note_feb = StringOption(_('Feb Note'), _('This prints in February')) note_feb.set_help(_("The note for the month of February")) menu.add_option(category_name, "note_feb", note_feb) note_mar = StringOption(_('Mar Note'), _('This prints in March')) note_mar.set_help(_("The note for the month of March")) menu.add_option(category_name, "note_mar", note_mar) note_apr = StringOption(_('Apr Note'), _('This prints in April')) note_apr.set_help(_("The note for the month of April")) menu.add_option(category_name, "note_apr", note_apr) note_may = StringOption(_('May Note'), _('This prints in May')) note_may.set_help(_("The note for the month of May")) menu.add_option(category_name, "note_may", note_may) note_jun = StringOption(_('Jun Note'), _('This prints in June')) note_jun.set_help(_("The note for the month of June")) menu.add_option(category_name, "note_jun", note_jun) category_name = _("Jul - Dec Notes") note_jul = StringOption(_('Jul Note'), _('This prints in July')) note_jul.set_help(_("The note for the month of July")) menu.add_option(category_name, "note_jul", note_jul) note_aug = StringOption(_('Aug Note'), _('This prints in August')) note_aug.set_help(_("The note for the month of August")) menu.add_option(category_name, "note_aug", note_aug) note_sep = StringOption(_('Sep Note'), _('This prints in September')) note_sep.set_help(_("The note for the month of September")) menu.add_option(category_name, "note_sep", note_sep) note_oct = StringOption(_('Oct Note'), _('This prints in October')) note_oct.set_help(_("The note for the month of October")) menu.add_option(category_name, "note_oct", note_oct) note_nov = StringOption(_('Nov Note'), _('This prints in November')) note_nov.set_help(_("The note for the month of November")) menu.add_option(category_name, "note_nov", note_nov) note_dec = StringOption(_('Dec Note'), _('This prints in December')) note_dec.set_help(_("The note for the month of December")) menu.add_option(category_name, "note_dec", note_dec) def __update_filters(self): """ Update the filter list based on the selected person """ gid = self.__pid.get_value() person = self.__db.get_person_from_gramps_id(gid) filter_list = ReportUtils.get_person_filters(person, False) self.__filter.set_filters(filter_list) def __filter_changed(self): """ Handle filter change. If the filter is not specific to a person, disable the person option """ filter_value = self.__filter.get_value() if filter_value in [1, 2, 3, 4]: # Filters 1, 2, 3 and 4 rely on the center person self.__pid.set_available(True) else: # The rest don't self.__pid.set_available(False) def __multiyear_changed(self): """ Handles the ability to print multiple year calendars or not? """ self.__start_year.set_available(True) if self.__multiyear.get_value(): self.__end_year.set_available(True) else: self.__end_year.set_available(False) def _get_regular_surname(sex, name): """ Returns a name string built from the components of the Name instance. """ surname = name.surname prefix = name.get_surname_prefix() if prefix: surname = prefix + " " + surname if sex is not gen.lib.Person.FEMALE: suffix = name.get_suffix() if suffix: surname = surname + ", " + suffix return surname def _get_short_name(person, maiden_name=None): """ Return person's name, unless maiden_name given, unless married_name listed. """ # Get all of a person's names: primary_name = person.get_primary_name() sex = person.get_gender() married_name = None names = [primary_name] + person.get_alternate_names() for name in names: if int(name.get_type()) == gen.lib.NameType.MARRIED: married_name = name # Now, decide which to use: if maiden_name is not None: if married_name is not None: first_name, family_name = married_name.get_first_name(), \ _get_regular_surname(sex, married_name) call_name = married_name.get_call_name() else: first_name, family_name = primary_name.get_first_name(), \ maiden_name call_name = primary_name.get_call_name() else: first_name, family_name = primary_name.get_first_name(), \ _get_regular_surname(sex, primary_name) call_name = primary_name.get_call_name() # If they have a nickname use it if call_name is not None and call_name.strip() != "": first_name = call_name.strip() else: # else just get the first name: first_name = first_name.strip() if " " in first_name: # just one split max first_name, rest = first_name.split(" ", 1) return ("%s %s" % (first_name, family_name)).strip() # Simple utility list to convert Gramps day-of-week numbering # to calendar.firstweekday numbering dow_gramps2iso = [ -1, calendar.SUNDAY, calendar.MONDAY, calendar.TUESDAY, calendar.WEDNESDAY, calendar.THURSDAY, calendar.FRIDAY, calendar.SATURDAY, ] # define names for full and abbreviated month names in GrampsLocale full_month_name = GrampsLocale.long_months abbr_month_name = GrampsLocale.short_months def get_full_month_name(month): """ returns full or long month name """ return full_month_name[month] def get_short_month_name(month): """ return short or abbreviated month name """ return abbr_month_name[month] def get_day_list(event_date, holiday_list, bday_anniv_list): """ Will fill day_list and return it to its caller: calendar_build() holiday_list -- list of holidays for event_date bday_anniv_list -- list of birthdays and anniversaries for event_date event_date -- date for this day_list 'day_list' - a combination of both dictionaries to be able to create one day nyears, date, text, event --- are necessary for figuring the age or years married for each day being created... """ # initialize day_list day_list = [] # holiday on this day if holiday_list > []: # will force holidays to be first in the list nyears = 0 for event_name in holiday_list: for line in event_name.splitlines(): day_list.append((nyears, event_date, line, 'Holiday')) # birthday/ anniversary on this day if bday_anniv_list > []: for text, event, date in bday_anniv_list: # '...' signifies an incomplete date for an event. See add_day_item() txt_str = None if date != '...': # number of years married, ex: 10 nyears = event_date.get_year() - date.get_year() # no negative years # years have to be at least zero if nyears > -1: # number of years for birthday, ex: 10 years age_str = event_date - date age_str.format(precision=1) # a birthday if event == 'Birthday': if nyears == 0: txt_str = _('%(person)s, birth') % { 'person' : text} else: txt_str = _('%(person)s, %(age)s old') % { 'person' : text, 'age' : age_str} # an anniversary elif event == 'Anniversary': if nyears == 0: txt_str = _('%(couple)s, wedding') % { 'couple' : text} else: txt_str = (ngettext('%(couple)s, %(years)d' ' year anniversary', '%(couple)s, %(years)d' ' year anniversary', nyears) % {'couple' : text, 'years' : nyears}) txt_str = '%s' % txt_str if txt_str is not None: day_list.append((nyears, date, txt_str, event)) # sort them based on number of years # holidays will always be on top of day day_list.sort() return day_list def get_marrital_status(db, family): """ Returns the marital status of two people, a couple are_married will either be the marriage event or None if not married anymore """ are_married = None for event_ref in family.get_event_ref_list(): event = db.get_event_from_handle(event_ref.ref) if event.type in [gen.lib.EventType.MARRIAGE, gen.lib.EventType.MARR_ALT]: are_married = event elif event.type in [gen.lib.EventType.DIVORCE, gen.lib.EventType.ANNULMENT, gen.lib.EventType.DIV_FILING]: are_married = None return are_married def get_first_day_of_month(year, month): """ Compute the first day to display for this month. It can also be a day in the previous month. """ current_date = datetime.date(year, month, 1) # first day of the month # monthinfo is filled using standard Python library # calendar.monthcalendar. It fills a list of 7-day-lists. The first day # of the 7-day-list is determined by calendar.firstweekday. monthinfo = calendar.monthcalendar(year, month) current_ord = current_date.toordinal() - monthinfo[0].count(0) return current_date, current_ord, monthinfo def get_previous_day(year, month, day_col): """ get last month's last week for previous days in the month """ if month == 1: prevmonth = calendar.monthcalendar(year - 1, 12) else: prevmonth = calendar.monthcalendar(year, month-1) num_weeks = len(prevmonth) lastweek_prevmonth = prevmonth[num_weeks - 1] previous_month_day = lastweek_prevmonth[day_col] return previous_month_day def get_next_day(year, month, day_col): """ get next month's first week for next days in the month """ if month == 12: nextmonth = calendar.monthcalendar(year + 1, 1) else: nextmonth = calendar.monthcalendar(year, month + 1) firstweek_nextmonth = nextmonth[0] next_month_day = firstweek_nextmonth[day_col] return next_month_day #------------------------------------------------------------------------- # # Register Plugin # #------------------------------------------------------------------------- pmgr = PluginManager.get_instance() pmgr.register_report( name = 'WebCal', category = CATEGORY_WEB, report_class = WebCalReport, options_class = WebCalOptions, modes = PluginManager.REPORT_MODE_GUI, translated_name = _("Web Calendar"), status = _("Stable"), author_name = "Thom Sturgill", author_email = "thsturgill@yahoo.com", description = _("Produces web (HTML) calendars."), )