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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright 2007-2008 Zuza Software Foundation
#
# This file is part of translate.
#
# translate 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 2 of the License, or
# (at your option) any later version.
#
# translate 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 translate; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Class that manages iCalender files for translation
Implementation
==============
iCalendar files follow the U{RFC2445<http://tools.ietf.org/html/rfc2445>}
specification.
The iCalendar specification uses the following naming conventions:
- Component: an event, journal entry, timezone, etc
- Property: a property of a component: summary, description, start time, etc
- Attribute: an attribute of a property, e.g. language
The following are localisable in this implementation:
- VEVENT component: SUMMARY, DESCRIPTION, COMMENT and LOCATION properties
While other items could be localised this is not seen as important until use
cases arise. In such a case simply adjusting the component.name and
property.name lists to include these will allow expanded localisation.
LANGUAGE Attribute
------------------
While the iCalendar format allows items to have a language attribute this is
not used. The reason being that for most of the items that we localise they
are only allowed to occur zero or once. Thus 'summary' would ideally
be present in multiple languages in one file, the format does not allow
such multiple entries. This is unfortunate as it prevents the creation
of a single multilingual iCalendar file.
Future Format Support
=====================
As this format used U{vobject<http://vobject.skyhouseconsulting.com/>} which
supports various formats including U{vCard<http://en.wikipedia.org/wiki/VCard>}
it is possible to expand this format to understand those if needed.
"""
from translate.storage import base
from StringIO import StringIO
import re
import vobject
class icalunit(base.TranslationUnit):
"""An ical entry that is translatable"""
def __init__(self, source=None, encoding="UTF-8"):
self.location = ""
if source:
self.source = source
super(icalunit, self).__init__(source)
def addlocation(self, location):
self.location = location
def getlocations(self):
return [self.location]
class icalfile(base.TranslationStore):
"""An ical file"""
UnitClass = icalunit
def __init__(self, inputfile=None, unitclass=icalunit):
"""construct an ical file, optionally reading in from inputfile."""
self.UnitClass = unitclass
base.TranslationStore.__init__(self, unitclass=unitclass)
self.units = []
self.filename = ''
self._icalfile = None
if inputfile is not None:
self.parse(inputfile)
def __str__(self):
_outicalfile = self._icalfile
for unit in self.units:
for location in unit.getlocations():
match = re.match('\\[(?P<uid>.+)\\](?P<property>.+)', location)
for component in self._icalfile.components():
if component.name != "VEVENT":
continue
if component.uid.value != match.groupdict()['uid']:
continue
for property in component.getChildren():
if property.name == match.groupdict()['property']:
property.value = unit.target
if _outicalfile:
return str(_outicalfile.serialize())
else:
return ""
def parse(self, input):
"""parse the given file or file source string"""
if hasattr(input, 'name'):
self.filename = input.name
elif not getattr(self, 'filename', ''):
self.filename = ''
if hasattr(input, "read"):
inisrc = input.read()
input.close()
input = inisrc
if isinstance(input, str):
input = StringIO(input)
self._icalfile = vobject.readComponents(input).next()
else:
self._icalfile = vobject.readComponents(open(input)).next()
for component in self._icalfile.components():
if component.name == "VEVENT":
for property in component.getChildren():
if property.name in ('SUMMARY', 'DESCRIPTION', 'COMMENT', 'LOCATION'):
newunit = self.addsourceunit(property.value)
newunit.addnote("Start date: %s" % component.dtstart.value)
newunit.addlocation("[%s]%s" % (component.uid.value, property.name))
|
