README.md 4.02 KB
Newer Older
Adrien Dorsaz's avatar
Adrien Dorsaz committed
1
What about qtmoko-ics2qtcal ?
Adrien Dorsaz's avatar
Adrien Dorsaz committed
2
-----------------------------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
3
4

This program transfers the content of ical files (.ics) into the [QtMoko's calendar](http://qtmoko.sourceforge.net).
Adrien Dorsaz's avatar
Adrien Dorsaz committed
5

Adrien Dorsaz's avatar
Adrien Dorsaz committed
6
7
8
It has been reported to work on a Google Calendar private URL, an Office Online calendar and with Davical calendar.

It currently does not have any user-interface (but will have soon see Trim/getcal repo), and is written with a mix of Perl and shell script.
Adrien Dorsaz's avatar
Adrien Dorsaz committed
9

Adrien Dorsaz's avatar
Adrien Dorsaz committed
10
11
We aren't expert in those languages : the code can probably be improved (suggestions and help are welcome!) and the ical RFC isn't completed (but feature demands and bug reports are welcome).

12
13
14
15
Installation
------------

You can either :
Adrien Dorsaz's avatar
Adrien Dorsaz committed
16
* clone the master branch from [github](https://github.com/Trim/qtmoko-ics2qtcal.git) or from git://adorsaz.ch/qtmoko-ics.git
17
18
* download zip created for each tags/revisions
* download and install [.deb packages](https://redmine.adorsaz.ch/projects/ics2qtcal_/files)
Adrien Dorsaz's avatar
Adrien Dorsaz committed
19
* create and install .deb package by cloning master and debian branch and runing "gbp buildpackage"
20

Adrien Dorsaz's avatar
Adrien Dorsaz committed
21
How can I use it ?
Adrien Dorsaz's avatar
Adrien Dorsaz committed
22
------------------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
23
24
25
26
27

It can run on a standard computer, or on the phone itself.
In current version, it downloads one ore several .ics files through HTTP(S), and stores their content into the SQLite database (/home/root/Applications/Qtopia/qtopia_db.sqlite , __replacing__ and removing existing appointments).
It also creates the Note files for each appointment description, in the directory where they are expected by QtMoko : /home/root/Applications/Annotator/

28
### Usage on QtMoko (tested on v52):
Adrien Dorsaz's avatar
Adrien Dorsaz committed
29
30
- Copy all the files in a directory of your phone (you can use git clone if you've install git, download zip file from github or [.deb package](https://redmine.adorsaz.ch/projects/ics2qtcal_/files))
- Install the necessary Perl packages by running install_dependencies.sh on the phone, if you've taken source files
Adrien Dorsaz's avatar
Adrien Dorsaz committed
31
- Run the script sync4ics2openmoko.sh [-u user] [-p password] [-s serverurl] fileurl1 fileurl2 ...
Adrien Dorsaz's avatar
Adrien Dorsaz committed
32

Adrien Dorsaz's avatar
Adrien Dorsaz committed
33
34
The optional user/password is given to the HTTP server if it needs authentication

35
#### Examples
Adrien Dorsaz's avatar
Adrien Dorsaz committed
36
37
38
39
- sync4ics2openmoko.sh (will parse all local files with extension .ics)
- sync4ics2openmoko.sh -u 'myuser' -p 'mypassword' -s https://myserver/mypath/ myfile1 myfile2 myfile3 
- sync4ics2openmoko.sh -u 'myuser' -p 'mypassword' -s https://myserver/ mypath1/myfile1 mypath1/myfile2 anotherpath/myfile3 

40
### Usage on Desktop
mossroy's avatar
mossroy committed
41
Usage on a standard computer (tested on Ubuntu 10.04 and 12.04) : same steps, except that you need to use remotesync4ics2openmoko.sh instead and connect your phone with IP 192.168.0.202.
Adrien Dorsaz's avatar
Adrien Dorsaz committed
42
43

How does it work ?
Adrien Dorsaz's avatar
Adrien Dorsaz committed
44
------------------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
45
46
47
48
49

* ics2qtcal.pl is where the hard job is done. This script has several options and you can use it alone
* sync4ics2openmoko.sh and remotesync4ics2openmoko.sh automate the operations described above. They are targeted on my own usage, but you can modify them if you wish.

Sources
Adrien Dorsaz's avatar
Adrien Dorsaz committed
50
-------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
51

Adrien Dorsaz's avatar
Adrien Dorsaz committed
52
53
54
55
* Idea taken from [openmoko wiki](http://wiki.openmoko.org/wiki/PIM_Storage#Import.2FExport_of_Calendar_Data_for_PIM-Storage) by Niebert
* [Original application](http://mossroy.free.fr/ics2qtcal/) from Mossroy
* Some code inspired or copied from [cpan](http://cpansearch.perl.org/src/BSDZ/Tie-iCal-0.14/samples/outlooksync.pl)
* The [iCal RFC](http://www.faqs.org/rfcs/rfc2445.html) implementation is quite incomplete in this script, but it covers the most common options
Adrien Dorsaz's avatar
Adrien Dorsaz committed
56

57
58
59
Developer notes
---------------

Adrien Dorsaz's avatar
Adrien Dorsaz committed
60
The qtmoko-ics work is done through the master branch and the debian stuff is located on the debian branch.
61

Adrien Dorsaz's avatar
Adrien Dorsaz committed
62
Suggestions/bugs
Adrien Dorsaz's avatar
Adrien Dorsaz committed
63
----------------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
64

mossroy's avatar
mossroy committed
65
Please send any suggestion/bug report to adrien AT adorsaz DOT ch, mossroy AT free DOT fr, or use github tools
Adrien Dorsaz's avatar
Adrien Dorsaz committed
66
67

License
Adrien Dorsaz's avatar
Adrien Dorsaz committed
68
-------
Adrien Dorsaz's avatar
Adrien Dorsaz committed
69
70
71
72

This program 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, version 3 of the License.

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.