/usr/share/gtk-doc/html/libecal/libecal-e-cal-check-timezones.html is in libecal1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-cal-check-timezones</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="prev" href="libecal-e-cal-system-timezone.html" title="e-cal-system-timezone">
<link rel="next" href="ch02.html" title="Deprecated Classes">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libecal-e-cal-system-timezone.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Calendar Client (libecal)</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libecal-e-cal-check-timezones.synopsis" class="shortcut">Top</a>
|
<a href="#libecal-e-cal-check-timezones.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libecal-e-cal-check-timezones"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libecal-e-cal-check-timezones.top_of_page"></a>e-cal-check-timezones</span></h2>
<p>e-cal-check-timezones</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libecal-e-cal-check-timezones.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gboolean</span> <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()">e_cal_client_check_timezones</a> (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><span class="type">GList</span> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer ecalclient, GCancellable *cancellable, GError **error)</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> ecalclient</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">icaltimezone</span> * <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-tzlookup" title="e_cal_client_tzlookup ()">e_cal_client_tzlookup</a> (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> ecalclient</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">icaltimezone</span> * <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-tzlookup-icomp" title="e_cal_client_tzlookup_icomp ()">e_cal_client_tzlookup_icomp</a> (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-match-tzid" title="e_cal_match_tzid ()">e_cal_match_tzid</a> (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-check-timezones" title="e_cal_check_timezones ()">e_cal_check_timezones</a> (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><span class="type">GList</span> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer custom, GError **error)</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">icaltimezone</span> * <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-tzlookup-ecal" title="e_cal_tzlookup_ecal ()">e_cal_tzlookup_ecal</a> (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">icaltimezone</span> * <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-tzlookup-icomp" title="e_cal_tzlookup_icomp ()">e_cal_tzlookup_icomp</a> (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libecal-e-cal-check-timezones.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libecal-e-cal-check-timezones.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-cal-client-check-timezones"></a><h3>e_cal_client_check_timezones ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_cal_client_check_timezones (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><span class="type">GList</span> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer ecalclient, GCancellable *cancellable, GError **error)</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> ecalclient</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE
items which are to be imported into Evolution.
</p>
<p>
Using VTIMEZONE definitions is problematic because they cannot be
updated properly when timezone definitions change. They are also
incomplete (for compatibility reason only one set of rules for
summer saving changes can be included, even if different rules
apply in different years). This function looks for matches of the
used TZIDs against system timezones and replaces such TZIDs with
the corresponding system timezone. This works for TZIDs containing
a location (found via a fuzzy string search) and for Outlook TZIDs
(via a hard-coded lookup table).
</p>
<p>
Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, <a class="link" href="libecal-ECal.html#e-cal-get-component-as-string" title="e_cal_get_component_as_string ()"><code class="function">e_cal_get_component_as_string()</code></a> fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.
</p>
<p>
If this mapping fails, this function also deals with VTIMEZONE
conflicts: such conflicts occur when the calendar already contains
an old VTIMEZONE definition with the same TZID, but different
summer saving rules. Replacing the VTIMEZONE potentially breaks
displaying of old events, whereas not replacing it breaks the new
events (the behavior in Evolution <= 2.22.1).
</p>
<p>
The way this problem is resolved is by renaming the new VTIMEZONE
definition until the TZID is unique. A running count is appended to
the TZID. All items referencing the renamed TZID are adapted
accordingly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
<td>a VCALENDAR containing a list of
VTIMEZONE and arbitrary other components, in
arbitrary order: these other components are
modified by this call</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>comps</code></em> :</span></p></td>
<td>a list of icalcomponent instances which
also have to be patched; may be NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tzlookup</code></em> :</span></p></td>
<td>a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()"><code class="function">e_cal_client_check_timezones()</code></a>
(to be compatible with <a class="link" href="libecal-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>);
NULL indicates that no such timezone exists
or an error occurred</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ecalclient</code></em> :</span></p></td>
<td>an arbitrary pointer which is passed through to
the <em class="parameter"><code>tzlookup</code></em> function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <span class="type">GCancellable</span> to use in <em class="parameter"><code>tzlookup</code></em> function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>an error description in case of a failure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if successful, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-tzlookup"></a><h3>e_cal_client_tzlookup ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> * e_cal_client_tzlookup (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> ecalclient</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
An implementation of the tzlookup callback which clients
can use. Calls <a class="link" href="libecal-ECalClient.html#e-cal-client-get-timezone-sync" title="e_cal_client_get_timezone_sync ()"><code class="function">e_cal_client_get_timezone_sync()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ecalclient</code></em> :</span></p></td>
<td>must be a valid ECalCleint pointer</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-tzlookup-icomp"></a><h3>e_cal_client_tzlookup_icomp ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> * e_cal_client_tzlookup_icomp (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
An implementation of the tzlookup callback which backends
like the file backend can use. Searches for the timezone
in the component list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>custom</code></em> :</span></p></td>
<td>must be a icalcomponent pointer which contains
either a VCALENDAR with VTIMEZONEs or VTIMEZONES
directly</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-match-tzid"></a><h3>e_cal_match_tzid ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_cal_match_tzid (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>);</pre>
<p>
Matches <em class="parameter"><code>tzid</code></em> against the system timezone definitions
and returns the matching TZID, or <code class="literal">NULL</code> if none found
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tzid</code></em> :</span></p></td>
<td>a timezone ID</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.24</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-check-timezones"></a><h3>e_cal_check_timezones ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_cal_check_timezones (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><span class="type">GList</span> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer custom, GError **error)</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_cal_check_timezones</code> has been deprecated since version 3.2 and should not be used in newly-written code. Use <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()"><code class="function">e_cal_client_check_timezones()</code></a> instead.</p>
</div>
<p>
This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE
items which are to be imported into Evolution.
</p>
<p>
Using VTIMEZONE definitions is problematic because they cannot be
updated properly when timezone definitions change. They are also
incomplete (for compatibility reason only one set of rules for
summer saving changes can be included, even if different rules
apply in different years). This function looks for matches of the
used TZIDs against system timezones and replaces such TZIDs with
the corresponding system timezone. This works for TZIDs containing
a location (found via a fuzzy string search) and for Outlook TZIDs
(via a hard-coded lookup table).
</p>
<p>
Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, <a class="link" href="libecal-ECal.html#e-cal-get-component-as-string" title="e_cal_get_component_as_string ()"><span class="type">e_cal_get_component_as_string</span></a> fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.
</p>
<p>
If this mapping fails, this function also deals with VTIMEZONE
conflicts: such conflicts occur when the calendar already contains
an old VTIMEZONE definition with the same TZID, but different
summer saving rules. Replacing the VTIMEZONE potentially breaks
displaying of old events, whereas not replacing it breaks the new
events (the behavior in Evolution <= 2.22.1).
</p>
<p>
The way this problem is resolved is by renaming the new VTIMEZONE
definition until the TZID is unique. A running count is appended to
the TZID. All items referencing the renamed TZID are adapted
accordingly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
<td>a VCALENDAR containing a list of
VTIMEZONE and arbitrary other components, in
arbitrary order: these other components are
modified by this call</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>comps</code></em> :</span></p></td>
<td>a list of icalcomponent instances which
also have to be patched; may be NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tzlookup</code></em> :</span></p></td>
<td>a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-check-timezones" title="e_cal_check_timezones ()"><code class="function">e_cal_check_timezones()</code></a>
(to be compatible with <a class="link" href="libecal-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>);
NULL indicates that no such timezone exists
or an error occurred</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>custom</code></em> :</span></p></td>
<td>an arbitrary pointer which is passed through to
the tzlookup function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>an error description in case of a failure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if successful, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.24</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-tzlookup-ecal"></a><h3>e_cal_tzlookup_ecal ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> * e_cal_tzlookup_ecal (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_cal_tzlookup_ecal</code> has been deprecated since version 3.2 and should not be used in newly-written code. Use <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-tzlookup" title="e_cal_client_tzlookup ()"><code class="function">e_cal_client_tzlookup()</code></a> instead.</p>
</div>
<p>
An implementation of the tzlookup callback which clients
can use. Calls <a class="link" href="libecal-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>custom</code></em> :</span></p></td>
<td>must be a valid ECal pointer</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.24</p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-tzlookup-icomp"></a><h3>e_cal_tzlookup_icomp ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> * e_cal_tzlookup_icomp (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> custom</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_cal_tzlookup_icomp</code> has been deprecated since version 3.2 and should not be used in newly-written code. Use <a class="link" href="libecal-e-cal-check-timezones.html#e-cal-client-tzlookup-icomp" title="e_cal_client_tzlookup_icomp ()"><code class="function">e_cal_client_tzlookup_icomp()</code></a> instead.</p>
</div>
<p>
An implementation of the tzlookup callback which backends
like the file backend can use. Searches for the timezone
in the component list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>custom</code></em> :</span></p></td>
<td>must be a icalcomponent pointer which contains
either a VCALENDAR with VTIMEZONEs or VTIMEZONES
directly</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.24</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|