User manual. Helsinki University of Technology T Software Development Project I

Transcription

1 Helsinki University of Technology T Software Development Project I Internet Peer-to-peer Calendaring and Scheduling Customer: Nokia Research Center Team: Tempus Document ID: Tempus-UM 2006/02/27 Revision: 1.8

2 Version History Version Date Author Description Approved by /02/27 Annu Myllyniemi Approving the document as finalized /02/17 Lauri Pitkà nen First version Tempus 2006/02/27 (rev 1.8)

3 Contents 1 Introduction 1 2 Installation Installing Sofia-SIP Getting Sofia-SIP Compiling and installing Sofia-SIP Setting the environment variables for Sofia-SIP Installing Tempus-sipcal Use Subscribing to a remote calendar Unsubscribing a remote calendar Publishing a local calendar Unpublishing a local calendar SIP calendar servers 3 5 Compiling Getting the Mozilla Sunbird source code Mozilla build requirements Compiling the Mozilla XPCOM module Compiling and Installing tempus-sipcal source package Known errors 5 References 6 Tempus 2006/02/27 (rev 1.8)

4 1 Introduction Tempus-sipcal is an extension for Mozilla Sunbird 0.3 alpha1. It is based on the Session Initiation Protocol (SIP) and a drafted calendaring extension to that protocol. Currently it is possible to subscribe to a calendar on a remote server and receive all updates to that calendar as well as publish an existing calendar to a remote server so that other users can subscribe to it. Subscription and publications can also be viewed and removed. 2 Installation The precompiled version of Tempus-sipcal requires an x86 based Linux system to run. Mozilla Sunbird 0.3 alpha1 and version of the Sofia-SIP library are also needed. Download and installation instructions for Mozilla Sunbird can be found from the Sunbird website [2]. Installation instructions for Sofia-SIP are provided below. In these instructions we will place the required support libraries and header files under /opt. This is not necessary if you do not intend to compile Tempus SIPcal, but we recommend it as you are installing a specific version of Sofia-SIP instead of the latest one. You will need root privileges to place files under /opt. 2.1 Installing Sofia-SIP Getting Sofia-SIP Download Sofia-SIP from the Sofia-SIP home page [3]. Select version sofia-sip tar.gz. Unpack the archive under /opt. cd /opt gunzip -c sofia-sip tar.gz tar xvf Compiling and installing Sofia-SIP Create a target directory for the installed Sofia-SIP environment and install it: mkdir -p /opt/sofia-sip cd /opt/sofia-sip /configure --prefix=/opt/sofia-sip make && make install To confirm that the package was installed type: Tempus 2006/02/27 (rev 1.8) 1 (6)

5 ls /opt/sofia-sip bin include lib libexec share You should see the above subdirectories under sofia-sip Setting the environment variables for Sofia-SIP As Sofia-SIP is in a non-standard location, you will need to add it to your library search path. To do this temporarily, you can use the command setenv LD_LIBRARY_PATH=$LIBRARY_PATH:/opt/sofia-sip/lib in tcsh or export LD_LIBRARY_PATH=$LIBRARY_PATH:/opt/sofia-sip/lib in bash before starting Sunbird. If you want to make this setting permanent, add the line to your shell configuration file. 2.2 Installing Tempus-sipcal Tempus-sipcal is provided as a Mozilla cross-platform installer (XPI) file. Open Sunbird and select Extensions from the Tools menu. Click Install, navigate to directory you have stored the XPI file and select the file. An entry will be shown in the extensions list stating the extension will be installed when Sunbird is restarted. Close the installation dialog and restart Sunbird. To confirm the installation take a look at the Tools menu. It should contain an entry called Tempus SIPcal close to the bottom of the menu. 3 Use Tempus-sipcal has four simple functions, which are described briefly below. 3.1 Subscribing to a remote calendar Open the Tools menu and select Tempus SIPcal. Select the Subscribe tab from the resulting dialog. Enter the SIP address of the SIP calendar server and, optionally, the remote calendar name. If no name is given, all viewable calendars will be returned. Now you can either choose to add the events from the subscribed calendar to an existing local calendar or create a new loacl calendar. To create a new local calendar, enter the name and colour to be used. To add the events to a local calendar, select the lower radio button and choose the calendar from the provided drop down list. Click on the Subscribe button to confirm the subscription. Tempus 2006/02/27 (rev 1.8) 2 (6)

6 3.2 Unsubscribing a remote calendar Open the Tools menu and select Tempus SIPcal. Select the Unsubsribe tab from the resulting dialog. Choose the corresponding local calendar from the drop down list and click Ok. The local calendar and alredy added events will not be deleted. If you no longer need the local calendar, it can be deleted by using the context menu of the Sunbird calendars list in the top left part of the main Sunbird window. Click on the Unsubscribe button. 3.3 Publishing a local calendar Open the Tools menu and select Tempus SIPcal. Select the Publish tab from the resulting dialog. Enter the calendar server address and select the local calendar to publish from the drop down list. Finally click on the Publish button. 3.4 Unpublishing a local calendar Open the Tools menu and select Tempus SIPcal. Select the Ubpublish tab from the resulting dialog. Choose the corresponding local calendar from the drop down list and click on the Ubpublish button. 4 SIP calendar servers Tempus-sipcal does not contain a server component. This software must be acquired and installed separately. 5 Compiling Compiling Tempus-sipcal is otherwise simple, but will first need to download and compile the Mozilla XPCOM module. You must also have the Sofia-SIP source code under /opt as intructed previously. 5.1 Getting the Mozilla Sunbird source code Download the Mozilla Sunbird source package from here: ftp://ftp.funet.fi/pub/mirrors/ftp.mozilla.org/sunbird/new-directory/releases/0.3a1/source/sunbird- 0.3a1-source.tar.bz2. and place it in /opt. You will need root privileges to do this. Alternatively you can use another directory, which does not need root privileges, but you will then have to modify the Tempus-sipcal Makefile as it is not automatically configured. Tempus 2006/02/27 (rev 1.8) 3 (6)

7 If a source package of Mozilla Sunbird 0.3 alpha1 is provided by you Linux distribution, we recommend installing it. This will take care of all build prerequisites. You can then either modify the source package or download the source as above and skip directly to the section on compiling the XPCOM module. 5.2 Mozilla build requirements You will need development packages for several libraries in order to compile this component. The Mozilla Linux build sie [4] has general instructions. We have found the following list to be helpful: X-window system (X.org or XFree86) development and libraries xorg-devel xorg-libs freetype freetype-devel freetype-utils gtk gtk+-devel gtk2 gtk2-devel glib-2.0 glib-devel-2.0 fontconfig fontconfig-devel atk atk-devel libidl libidl-devel Tempus 2006/02/27 (rev 1.8) 4 (6)

8 5.3 Compiling the Mozilla XPCOM module once you have taken care of the prerequisites, use the following commands to compile the module: cd /opt bunzip -c sunbird-0.3a1-source.tar.bz2 tar xvf - cd mozilla./configure --enable-application=standalone \ -enable-standalone-modules=xpcom If the configure script complains about missing packages or their pkg-config information, you need to install missing packages and re-compile the XPCOM component Compiling and Installing tempus-sipcal source package Tempus uses the Sourceforge.net Open Source code repository to store its own code. The following quidelines will instruct you to checkout, compile and install the Tempus-sipcal calendar extension. cd /opt cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/tempus-sipcal \ co tempus-sipcal cd tempus-sipcal make make xpi # make debug is also available for debugging use as # an alternative to make A tempus-sipcal-x.x.x.xpi package should now be available in the current directory and can be installed normally. 6 Known errors To be listed. Tempus 2006/02/27 (rev 1.8) 5 (6)

9 References [1] Tempus Technical Specification (Tempus-TS) [2] Mozilla Sunbird website [3] Sofia-SIP website [4] Mozilla Developer Center - Linux Build Prerequisites Tempus 2006/02/27 (rev 1.8) 6 (6)