Calendar:WCAP Provider: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
mNo edit summary
(removed &calid= usage, bug reference)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Please remind that this provider '''IS STILL PRELIMINARY, NO WARRANTY!'''
[[Calendar:Feature_Implementations| <<Back to Features]]


==Using==
==Using==


===Initial Steps===
 
You currently have two options to switch on WCAP support:
*Setting <code>calendar.wcap.enabled</code> to <code>true</code> will switch on the provider (only).
*Setting <code>calendar.prototypes.wcap</code> to <code>true</code> will enable the provider and the enhanced (though still prototypical) WCAP UI. (recommended, Lightning only)


===Subscribing To Your Calendar===
===Subscribing To Your Calendar===
The Sunbird/Lightning ''Create New Calendar'' wizard comes up with a third Format type for remote calendars (''Sun Java System Calendar Server (WCAP)'').  As location, provide a <code>HTTP</code> URL to a [http://www.sun.com/software/products/calendar_srvr/index.xml Sun Java System Calendar server].
The Sunbird/Lightning ''Create New Calendar'' wizard comes up with a third Format type for remote calendars (''Sun Java System Calendar Server (WCAP)'').  As location, provide a <code>HTTP</code> or preferrably <code>HTTPS</code> URL to a [http://www.sun.com/software/products/calendar_srvr/index.xml Sun Java System Calendar server].
<pre>
<pre>
http://sd-calendar.staroffice.de/
http://sd-calendar.staroffice.de/
</pre>
</pre>
If you need to login as different users on the same server, then create multiple calendar accounts, encoding user-Ids into the corresponding URLs, e.g. creating one calendar
You can encode your common user-id into the url which will be used for the login prompt, e.g.
<pre>
<pre>
http://jdoe@sd-calendar.staroffice.de/
http://jdoe@sd-calendar.staroffice.de/
</pre>
and another
<pre>
http://bbat@sd-calendar.staroffice.de/
</pre>
</pre>
After creation, you need to switch the view on for this calendar in the ''Calendars'' list.
After creation, you need to switch the view on for this calendar in the ''Calendars'' list.
Line 26: Line 19:
For login, you will be asked for a pair of ''UserName/Password''.
For login, you will be asked for a pair of ''UserName/Password''.
If you don't pass login, you will be asked again.
If you don't pass login, you will be asked again.
If you cancel login, you won't be asked
If the calendar server does not support <code>HTTPS</code>, you will be asked whether to continue the login.
again anymore.
<code>HTTPS</code> is enforced, even if you have specified plain <code>HTTP</code>,
because the password is transmitted.  If the calendar server does not
support <code>HTTPS</code> (at least for login), you will be asked whether to
continue the login.  For calendar data retrieval, the specified protocol
(<code>HTTP</code>, <code>HTTPS</code>) of the URL is used.


===UI===
===UI===
Line 38: Line 25:
can be confusing if the selected calendar is not shown (unchecked), i.e.
can be confusing if the selected calendar is not shown (unchecked), i.e.
you won't see your newly created event.  IMO we have to improve this.
you won't see your newly created event.  IMO we have to improve this.
===Alarms===
Alarms are  currently turned ''off'' by default, because of [http://groups.google.de/group/mozilla.dev.apps.calendar/browse_thread/thread/3bd7188c29309452/311545e3d102642c?hl=de#311545e3d102642c exception bloat (#3)]. You can switch them on defining
user_pref("calendar.wcap.suppress_alarms", false);


==Logging==
==Logging==
Line 49: Line 32:
[[#Log_File|log file]].
[[#Log_File|log file]].


Three log levels are defined:
Four log levels are defined:
*0 &rarr; no logging (release, default)
*0 &rarr; no logging (release, default)
*1 &rarr; some logging, connection etc., but no calendar data
*1 &rarr; some logging, connection etc., but no calendar data
*2 &rarr; full log
*2 &rarr; verbose log
*3 &rarr; very verbose log


You can increase the log level your <code>user.js</code> in your profile:
You can set the log level your <code>user.js</code> in your profile:
  user_pref("calendar.wcap.log_level", ''n'');
  user_pref("calendar.wcap.log_level", ''n'');
 
or via ''Tools&rarr;Options&rarr;Advanced&rarr;General&rarr;Config Editor...'' (Thunderbird 2, Unix) and even change it without restarting Thunderbird.
Building Lightning, the ''default'' log level (i.e. 0) can be overridden, e.g.
make wcap_logging=2
 
The effective log level is
max( build-default-log-level, user-pref-log-level )


===Log File===
===Log File===
You can specify a log file. Logs are always appended to the specified file.
You can specify a log file. Logs are always appended to the specified file.
  user_pref("calendar.wcap.log_file", "''/system/path/to/log/file''");
  user_pref("calendar.wcap.log_file", "''/system/path/to/log/file''"); // *nix
user_pref("calendar.wcap.log_file", "''c:\\system\\path\\to\\log\\file''"); // Windows
user_pref("calendar.wcap.log_file_append", true); // whether log should be appended, default is false (truncate)


<!-- currently not working
==Trouble Shooting==
=='''EXPERIMENTAL''' Local Caching==
*Some Calendar server versions cause trouble using the <code>get_calprops.wcap</code> command. If you encounter trouble with your version, the WCAP provider has a workaround using the <code>search_calprops.wcap</code> command. You can switch the usage setting pref
You have two options for caching:
  calendar.wcap.no_get_calprops &rarr; true
*in-memory &rarr; <code>memory</code>
*persistent on hard disc &rarr; <code>storage</code>
using the following preference.
''By default, local caching is currently turned ''off'', because of performance problems using the storage provider'':
  user_pref("calendar.wcap.cache", "''[off|memory|storage]''");


For <code>storage</code> caching, all the caching data is stored by default in the following directory:
''profile-dir''/wcap
You can use a different directory by setting:
user_pref("calendar.wcap.cache_dir", "''/system/path/to/data/directory''");
'''If you feel the need to flush/renew your local calendar cache, just delete that directory. All data will be refreshed on next startup.'''
-->


==Misc==
[[category:calendar|WCAP Provider]]
*contribution tracked via [https://bugzilla.mozilla.org/show_bug.cgi?id=340949 issue 340949]

Latest revision as of 18:14, 20 April 2009

<<Back to Features

Using

Subscribing To Your Calendar

The Sunbird/Lightning Create New Calendar wizard comes up with a third Format type for remote calendars (Sun Java System Calendar Server (WCAP)). As location, provide a HTTP or preferrably HTTPS URL to a Sun Java System Calendar server. 

http://sd-calendar.staroffice.de/

You can encode your common user-id into the url which will be used for the login prompt, e.g. 

http://jdoe@sd-calendar.staroffice.de/

After creation, you need to switch the view on for this calendar in the Calendars list.

Login

For login, you will be asked for a pair of UserName/Password. If you don't pass login, you will be asked again. If the calendar server does not support HTTPS, you will be asked whether to continue the login.

UI

If you create items, keep care to have the correct calendar selected and checked in the Calendars list, because this will be the one for insertion. It can be confusing if the selected calendar is not shown (unchecked), i.e. you won't see your newly created event. IMO we have to improve this.

Logging

Log Level

The provider can log for diagnose purposes. Logs go to the js console, eventually to stdout (if user_pref("browser.dom.window.dump.enabled", true);) or log file.

Four log levels are defined:

  • 0 → no logging (release, default)
  • 1 → some logging, connection etc., but no calendar data
  • 2 → verbose log
  • 3 → very verbose log

You can set the log level your user.js in your profile: 

user_pref("calendar.wcap.log_level", n);

or via Tools→Options→Advanced→General→Config Editor... (Thunderbird 2, Unix) and even change it without restarting Thunderbird.

Log File

You can specify a log file. Logs are always appended to the specified file. 

user_pref("calendar.wcap.log_file", "/system/path/to/log/file"); // *nix
user_pref("calendar.wcap.log_file", "c:\\system\\path\\to\\log\\file"); // Windows
user_pref("calendar.wcap.log_file_append", true); // whether log should be appended, default is false (truncate)

Trouble Shooting

  • Some Calendar server versions cause trouble using the get_calprops.wcap command. If you encounter trouble with your version, the WCAP provider has a workaround using the search_calprops.wcap command. You can switch the usage setting pref
calendar.wcap.no_get_calprops → true
Retrieved from "https://wiki.mozilla.org/index.php?title=Calendar:WCAP_Provider&oldid=140637"