|
| |
WebCalendar System Administrator's Guide
WebCalendar Version: 1.0.0
Table of Contents
Introduction
WebCalender is an open source PHP-based multi-user calendar.
Features:
- Multi-user support
- Group support
- View day-at-glance
- View month-at-glance
- View week-at-glance
- View year-at-glance
- View another user's calendar
- View multiple users' calendars at the same time
- View one or more users' calendar via layers on top of your own calendar
- Public calendar (that requires no login) where anonymous users
submit events that are approved by an administrator
- Add/Edit/Delete users
- Add/Edit/Delete events
- Repeating events
- Custom event fields
- Search interface for calendar entries
- User-configurable preferences for colors, 12/24 time format,
Week start on Sun or Mon, default work hours
- Online help
- Checks for scheduling conflicts
- Support for multiple timezones
- Users can accept or reject events added by another user to their calendar
- Email reminders
- Email notifications for new events
- Support for 30 different languages:
- Basque
- Bulgarian
- Catalan
- 繁體中文(Big5)
- 简体中文(GB2312)
- Czech
- Danish
- Deutsch (German)
- English
- Español (Spanish)
- Estonian
- Français (French)
- Galician
- Hollands (Dutch)
- Holo (Taiwanese)
- Hungarian
- Icelandic
- Italiano (Italian)
- Japanese
- Korean
- Norsk (Norwegian)
- Polish
- Portuguese
- Portuguese/Brazil
- Romanian
- Русско (Russian)
- Suomalainen (Finnish)
- Svensk (Swedish)
- Turkish
- Welsh
- Exporting to and importing from:
- Authentication using:
- LDAP
- HTTP authentication
- NIS
- web-based
- Activity log that tracks:
- event creation
- event updates
- event acceptance
- event rejection
- email notifications
- email reminders
System Requirements
- PHP 4 (PHP 5 not yet tested) with magic_quotes_gpc enabled
- Database (see below)
- CSS-enabled browser
- JavaScript-enabled browser
- If not using HTTP-based authentication, then browser cookies are required
Recommended:
You must have one of the following databases installed:
- MySQL
- Oracle 8
- PostgreSQL
- Interbase
- MS SQL Server
- ODBC (PHP ODBC includes support for Adabas D, IBM DB2, Solid and Sybase SQL Anywhere as well as ODBC)
For the database you choose, you must have its drivers built into
PHP. For example, to use MySQL, PHP must be compiled with MySQL
support (which is the default setting when installing PHP).
See the PHP pages (www.php.net  )
for more information on setting up PHP.
No optional PHP packages (other than MySQL) are required for this
application. However, PHP shoud be compiled with --enable-track-vars
on some systems.
Make sure that magic_quotes_gpc in php.ini
is turned on (otherwise, you will get an error message when you try to access WebCalendar.)
TIP If you are using Apache
as your web server and if you cannot or do not want to enable
magic_quotes_gpc for your entire site, you can enable
it just for WebCalendar.
Create a .htaccess file in the toplevel WebCalendar
directory that contains a single line:
php_value magic_quotes_gpc 1
(For this to work with Apache, you must have the Apache
AllowOverride All directive enabled for the directory
where WebCalendar is installed.
Additionally, PHP must be running as an Apache module, not
a CGI.)
You can run PHP either as a CGI or an Apache module. You'll get better
performance with PHP setup as a module. Not only will you not have to
deal with the CGI performance hit, but you'll be able to use PHP's
database connection pooling. Additionally, this application can use
a form/cookie-based authentication or traditional HTTP authentication.
For traditional HTTP authentication, PHP must be built as an Apache
module.
If you are planning on using email reminders, you will need to build
PHP as a CGI in order to run the send_reminders.php script. I would
strongly recommend building a module-based PHP for your web server
and then a second PHP build to create the CGI version.
TIP Some Linux distributions come with both a module-based PHP
with Apache and a standalone PHP binary.
Check for /usr/bin/php to see if you already have the
PHP standalone executable. If it's there, you can use
the following command to see what version of PHP you have:
/usr/bin/php -v
File Unpacking
Unpack the calendar software in its own directory somewhere where
your web server will find it. (See your web server docs for info.)
By default, WebCalendar should create its own directory
when you unpack it. The new directory name will typically
contain the version name (such as WebCalendar-0.9.41).
You can rename this directory after unpacking the files if you
prefer a directory name like calendar or webcalendar.
Keep in mind that unless you remap the directory (via your web server's
configuration settings), it will be part of the URL for the calendar.
Database Setup
There are three steps in setting up the database:
- Creating the database
- Creating the user
- Creating the required tables
Follow the steps outlined below for the database you are using.
When complete, a single user account will be created
with the login "admin" and password "admin", which you are encouraged
to use to create your own account.
Note: In the examples below, text in bold
represents text that you must type in.
Security: The default values for database, login, and
password (intranet, webcalendar, and webcal01) are for demonstration purposes only
and should never be used in a production environment.
The following will create a database named "intranet".
mysqladmin create intranet
Next, create the database user account that will be used to access the database.
mysql --user=root mysql
mysql> GRANT ALL PRIVILEGES ON *.* TO webcalendar@localhost
IDENTIFIED BY 'webcal01' WITH GRANT OPTION;
mysql> FLUSH PRIVILEGES;
mysql> QUIT
If you will be accessing MySQL from a different machine than
the one running the web server, repeat the command above
and replace 'localhost' with the hostname of the other machine.
Create the calendar tables using the supplied tables-mysql.sql file:
mysql intranet < tables-mysql.sql
In the above example, "intranet" is the name of your database.
Note: If you are using
phpMyAdmin to
manage your MySQL database, follow the
instructions in Appendix A.
The following will create a tablespace named "webcalendar".
From the command line, startup sqlplus and
issue the following command:
sqlplus
SQL> CREATE TABLESPACE webcalendar
DATAFILE 'webcalendar.dat' SIZE 10M
AUTOEXTEND ON NEXT 10M MAXSIZE 40M;
Next, create the database user account that will be used to access the database.
sqlplus
SQL> CREATE USER webcalendar IDENTIFIED BY webcal01
DEFAULT TABLESPACE webcalendar;
SQL> GRANT dba TO webcalendar;
SQL> quit
Create the calendar tables using the supplied tables-oracle.sql file:
sqlplus webcalendar/webcal01
SQL> @tables-oracle;
SQL> quit
The following will create a database named "webcalendar".
From the command line, startup psql and
issue the following command:
create database webcalendar;
\c webcalendar
\i tables-postgres.sql
\q
The following will create a database named "WEBCAL.gdb".
From the command line, startup usql and
issue the following command:
CREATE DATABASE 'WEBCAL.gdb';
Create the calendar tables using the supplied tables-ibase.sql file:
isql
connect /path/WEBCAL.gdb;
input path/table-ibase.sql;
Setup will depend on which database you are using.
When it comes time to create the tables,
the tables-postgres.sql file should work for most
databases.
Create a database, intranet, and add a user, webcalendar, to access this database. The user should be granted public, db_datareader,
and db_datawriter privileges. Open SQL Query Analyzer then open
the file tables-postgres.sql. Make sure you have identified intranet as the target database and Execute the contents of the sql file.
Application Setup
Next, you will need to run the web-based database setup script
(simply direct your browser to your new WebCalendar location).
You will need to modify the permissions of the includes
directory. On Linux/UNIX, you should change this directory
to be read/write for all users (chmod 777 includes).
On Windows, change this directory to have full access for all users
using Windows Explorer. Changing the write permissions will allow the web-based
database configuration tool to create the settings.php file.
TIP After you have created the
settings.php file (with the "Save Settings" button),
you can change the permissions back to a more restrictive setting.
After you test and save your database settings, you
will be prompted to enter an installation password.
Write this password down somewhere. There is no way to reset
this password. If you forget this password and need to change your database settings,
you will need to manually edit the settings.php file with a text editor.
If you choose not to use the web-based database configuration
tool, you can manually edit the settings.php file.
There is an example file settings.php.orig that you
can use as a starting point. Simply rename this file to settings.php.
You will need to set the values as follows in settings.php:
To configure your database access. Set the values for:
|
db_type |
One of "mysql", "oracle", "postgresql", "odbc",
"mssql",
or "ibase"
|
|
db_host |
The hostname that database is running on.
(Use localhost if it's the same machine as
the web server.) (This variable is not used with ODBC)
|
|
db_login |
The database login
|
|
db_password |
The database password for the above login
|
|
db_database |
The name of the database that the calendar
tables reside in. ("intranet" in the examples above.)
For ODBC, this should be the DSN.
|
|
db_persistent |
Enable use of persistent (pooled) database connections.
This should typically be enabled.
|
You can configure the calendar to run in single-user* mode or
multi-user* mode. If this is your first time using the
calendar, it's easier to try single-user. You can always switch to multi-user
later. Leave single_user set to "N" (the default) for multi-user or set
it to "Y" and set the value of single_user_login to a login name of your liking
to set the system to single-user mode. (And be sure to set the value of
single_user_login to the login that you would choose if you decide to switch
to multi-user mode some day.)
Note: If you do decide to switch from single-user mode to multi-user mode,
make sure you add in a user to the system for the login you set the
single_user_login variable to. You will need to do this via the
database (mysql, sqlplus, etc.) Look in the tables-mysql.sql
(or tables-oracle.sql, etc.) to see the example of adding in the "admin" user.
If you are setting up a multi-user calendar, you will need to choose
how your users are authenticated. You must change the settings of
use_http_auth and user_inc
to setup which authentication method to use.
You currently have four choices:
- Web-based authentication (login/passwords verified in the WebCalendar database):
use_http_auth = false
user_inc = user.php
- HTTP-based authentication (login/passwords verified by the web server):
use_http_auth = true
user_inc = user.php
... and don't forget to setup your web server to handle user
authentication.
Note: In order to use HTTP-based authentication,
PHP must be setup as a module for your server rather than a CGI.
- NIS-based authentication (login/passwords verified by NIS):
use_http_auth = false
user_inc = user-nis.php
Additional configuration settings will need to be set
in includes/user-nis.php.
- LDAP-based authentication (login/passwords verified by LDAP server):
use_http_auth = false
user_inc = user-ldap.php
Additional configuration settings will need to be set
in includes/user-ldap.php.
Keep in mind that if you want to use reminders, you will need to
setup the send_reminders.php script (see below) and keep your admin
setting for "Email enabled" set to "Yes" on the admin settings page.
At this point, your WebCalendar installation should be up and running.
To access WebCalendar open up your favorite web browser and
type in the URL. The URL will depend on where you installed
WebCalendar.
When you unpacked/unzipped the WebCalendar distribution, it typically
creates a directory that includes the version number.
For example, if the zip file was named WebCalendar-0.9.99.zip
(or WebCalendar-0.9.99.tar.gz), then there
should be a WebCalendar-0.9.99 directory. For convenience, you
can rename this directory so that the URL does not include the version
number. On Windows, you can do this from the Windows Explorer.
On Linux/UNIX, you can use the mv command to rename the directory.
Supposing you renamed the WebCalendar-0.9.99 directory to just
be calendar, and you unpacked/unzipped the files into your toplevel
web server directory, the URL would be:
http://yourserverhere/calendar/index.php
If you have not previously configured your database settings,
you will be automatically redirected to a web page for
configuring your database settings. After you have configured the database,
use the URL again to access WebCalendar.
If you have configured your web server to use index.php as the
default index page for a directory, you can omit that from the URL.
On a single-user system, your browser should be redirected to week.php
initially. On a multi-user system, your browser should be redirected to login.php
so that you can login.
TIP On a multi-user system, the only user account created
during installation has the username of "admin" and a password of "admin". You should create
a new admin account and delete this one for security reasons.
Creating Users
After logging in as an admin user (the initial username is "admin" with
password "admin"), you will see a common set of links at the bottom
of each page. Follow these steps to create a new user:
- Login to WebCalendar as an admin user
- Click on the "Admin" link at the bottom of any WebCalendar page
- Click on the "Users" button
- Click on the "Add New User" link
- Fill out the form with details for the new user (email address is optional)
- Click on the "Save" button
TIP On a single-user system, you do not need to create any users.
TIP For an event calendar, you do not need to create a user for the "public user".
Setting Up Email Reminders
PHP does not come with a utility for executing time-based jobs.
So, in order to check periodically for email reminders, a shell
script was written in PHP. You will need two things to get this working:
- You should have a version of PHP built as a CGI (so that you can run
php from the command line). This does not mean you must build all
of PHP as a CGI. You can still build PHP as a module for your web
server and then build the CGI-based PHP later.
Note: Many Linux distributions and some Windows LAMP packages
come with the PHP built for CGI.
- You must setup cron (on Linux/UNIX) or something like cron for Windows
to run the send_reminders.php script periodically.
Building PHP as a CGI is outside the scope of these instructions. But,
if you read the PHP instructions, you'll see that the default build
settings will build the CGI-based PHP. If you really can't do this
(perhaps you don't have permission to install anything new on the
system), skip down a couple of paragraphs to an alternate solution
that does not require PHP CGI.
For Linux/UNIX users, add the following line to the crontab entry of
a user. (This would be the same user that the web server
process runs as.)
1 * * * * cd /some/directory/webcalendar/tools; ./send_reminders.php
Of course, replace the directory location to wherever the
send_reminders.php file can be found. If you moved this out of the
tools directory (which is recommended for security reasons),
be sure to update send_reminders.php since it needs
to know where to find other WebCalendar files.
If you cannot setup PHP as a CGI or have no idea how, you can leave
send_reminders.php in its current location and access it via a URL.
IMHO, this is not the best choice, but it still works. Setup a cron
job to access the URL. For Linux/UNIX users, add the following line to
the crontab entry of a user.
1 * * * * wget http://yourserverhere/webcalendardirectoryhere/tools/send_reminders.php > /dev/null
You should test this from the command line first to make sure your setup is
correct. If you do not have wget installed on your system, you can use
any tool (lynx, perl script, etc.) that is capable of making an HTTP request for this.
System Settings
System Settings allows the administrator to control what features are available to users
as well as default values for certain features.
Many of these settings can be overridden by users in their Preferences (such as color).
Settings
- Application Name
- Specifies the document title (typically displayed in the window title bar
of most browsers)
- Server URL
- Specifies the base URL of the calendar. This information is needed to
accurately include URLs in email messages (Notifications and Reminders).
- Language
- Specifies the default language setting for all users.
- Fonts
- Specifies your preferred font. Multiple font names should be comma-separated.
- Preferred View
- Specify if users should see the day, week, month, or year after loggin in.
- Display weekends in view
- Specifies default setting for if Saturdays and Sundays should appear in the
calendar when viewing a month or week
- Date format
- Specifies the default format for displaying dates
- Time format
- Specifies the default time format as either 12-hour (3:45pm) or 24-hour (15:14)
- Time interval
- Specify the default number of minutes each time block represents in the day and
week display
- Auto-referesh calendars
- If set to "yes," the day, week, and month pages will automatically
reload after a specified duration
- Auto-refresh time
- Specifies how long to wait before the auto-refresh should force a page
to be reloaded
- Display unapproved
- Specifies whether events that have been added to a calendar but not yet
approved should display on the calendar (in a different color)
- Display week number
- Specifies whether the week number should be displayed in month and week views
- Week starts on
- Specifies if week start on Sunday or Monday
- Work hours
- Specifies the default time range to display in day and week views
- Disable Priority field
- If enabled, the Priority field will not be used
- Disable Access field
- If enabled, the Access field will not be used
- Disable Participants field
- If enabled, the Participants field will not be used, and users will not be
able to add events to any calendar other than their own.
- Disable Repeating field
- If enabled, users will not be able to create repeating events
- Allow viewing other user's calendars
- If enabled, users will be able to view the calendar of another user
- Allow public access
- If enabled, anonymous users will be able to view the public access
calendar without logging in.
- Public access can view other users
- If enabled, anonymous users will be able to view the calendars of other users
- Public access can add events
- If enabled, anonymous users will be able to submit new events.
- Public access new events require approval
- If enabled, events submitted to the public access calendar (by anonymous
users) will require approval by an admin user. If not enabled, then new events
will appear on the public access calendar as soon as they are submitted.
- Include add event link in views
- If enabled, Views will include a link to quickly add events to the
specified user's calendar.
- Allow external users
- If enabled, the create/edit event page will contain a text area to include
the names (and optional email address) of event participants that are not calendar users.
- External users can receive email notifications
- If enabled, event participants entered into the External Participants
area will receive email notifications at the same time as calendar users (if an email
address was specified for the Exernal Participant).
- External users can receive email reminders
- If enabled, event participants entered into the External Participants
area will receive email reminders at the same time as calendar users (if an email
address was specified for the Exernal Participant).
- Remember last login
- If enabled, when a returning calendar user reaches the login page, their login name will be pre-filled with the last login username that they entered. (The password field will still be blank.)
- Check for event conflicts
- Specifies if the system should check for scheduling conflicts when a user adds or updates an event.
- Conflict checking months
- If conflict checking is enabled, this specifies how many months past the initial date the system will check for conflicts when a user adds or updates a repeating event.
- Allow users to override conflicts
- If enabled, users will be warned when there is an event conflict and be presented with the option of scheduling the event anyhow.
- Limit number of timed events per day
- If enabled, users can can be limited to a specific number of timed events per day
- Maximum timed events per day
- Specifies that maximum number of events that can be scheduled in one day of any one user.
Groups
- Groups enabled
- Specifies if group features should be enabled
- User sees only his group
- If enabled, users will be unaware of any users that are not in the same group as the user.
Categories
- Cagtegoies enabled
- Specifies if category features should be enabled
Email
- Email enabled
- Specifies if email functionality should be enabled. If set to "No," then no email messages will be sent at any time.
- Default sender address
- Specifies the email originator to use when the system sends out email Notifications and Reminders
- Event reminders
- Specifies if email reminders for events that include a reminder should be sent
- Events added to my calendar
- Specifies if the system should send email when an event is added
- Events updated on my calendar
- Specifies if the system should send email when an event is updated
- Events removed from my calendar
- Specifies if the system should send email when an event is deleted
- Event rejected by participant
- Specifies if the system should send email when a participant to an event rejects the event
Colors
- Allow user to customize colors
- Specifies whether color settings should be available to users in their Preferences
- Document background
- Specifies the background color of all pages
- Document title
- Specifies the color of page title on each page
- Document text
- Specifies the default text color on each page
- Table grid color
- Specifies color of the lines that make HTML table grids on each page
- Table header background
- Specifies the default background for the heading of any HTML table
- Table header text
- Specifies the default text color for the heading of any HTML table
- Table cell background
- Specifies the background color for table cells
- Table cell background for current day
- Specifies the background color for the table cell containing the current date
- Table cell background for weekend
- Specifies the background color for table cells that represent a Saturday or Sunday
- Event popup background
- Specifies the background color of event popup areas
- Event popup text
- Specifies the text color of event popup areas
Custom Event Fields
You may want to customize the event-specific fields found in
the includes/site_extras.php field.
If this is your first time using the calendar, you can skip
this step and come back later since this step
is optional.
You can use this feature to add extra
fields to your calendar events. For example, you can add a URL,
a contact email address, or a location.
By default, this file is configured with
a single reminder field that allows the user to specify how long
before the event the reminder should be sent.
TIP See instructions on setting
up reminders to enable sending of reminders.
When defining a new custom field, the following types listed below
are available. "Arg 1" and "Arg 2" have different meaning depending on the type
of field. In some cases, "Arg 1" and "Arg 2" are not used.
|
Type |
Description |
Arg 1 |
Arg 2
|
|---|
|
EXTRA_TEXT |
Allows the user to enter a single line of text |
Specifies the size of the text form element as it would appear in the
following ("NN" would be replaced with Arg 1):
<input size="NN" ... |
N/A
|
|
EXTRA_MULTILINETEXT |
Allows the user to enter multiple lines of text |
Specifies how many characters wide the textform element should be as it
would appear in the following ("NN" would be replaced with Arg 1):
<textarea cols="NN" ... |
Specifies how many lines long the textform element should be as it would
appear in the following ("NN" would be replaced with Arg 1):
<textarea rows="NN" ...
|
|
EXTRA_URL |
Allows the user to enter a single line of text and will be displayed as a
link when viewed |
N/A |
N/A
|
|
EXTRA_DATE |
Allows the user to select a date using the standard date selection form
elements |
N/A |
N/A
|
|
EXTRA_EMAIL |
Allows the user to enter a single line of text and will be displayed as
a mailto URL link |
N/A |
N/A
|
|
EXTRA_REMINDER |
Allows the user to specify if a reminder should be sent out for
the event |
Specifies how many minutes before the event that the reminder
should be sent. |
Specifies other reminder-specific options. The following options are available:
- $EXTRA_REMINDER_WITH_DATE
- $EXTRA_REMINDER_WITH_OFFSET
- $EXTRA_REMINDER_DEFAULT_YES
If more than one option is needed, they should be or-ed together with
the | character.
|
|
EXTRA_REMINDER_DATE |
Allows the user to specify if a reminder should be sent out for the event
and and what time it should be sent |
Specifies the default for how many minutes before the event that the
reminder should be sent. The user can override this when they create/edit
the event. |
Specifies other reminder-specific options. The following options are available:
- $EXTRA_REMINDER_WITH_DATE
- $EXTRA_REMINDER_WITH_OFFSET
- $EXTRA_REMINDER_DEFAULT_YES
If more than one option is needed, they should be or-ed together with
the | character.
|
|
EXTRA_SELECTION_LIST |
Presents the user with a selection list (single selection) to choose from |
Specifies the list of available options using the PHP array
function |
N/A
|
Frequently Asked Questions
- How do I setup PHP, MySQL and Apache on Windows?
- The easiest way to do this is to try one of the prepackaged bundles that will install all of these for you:
- How do I setup PHP, MySQL and Apache on UNIX/Linux?
- There are many online instructions on how to do this. Here are a few:
- I've finished the install. What is the login to WebCalendar?
- After the initial creation of the database tables, there will
be a single user account created with the username "admin" and
the password set to "admin" as well.
Note: This account is intended to get your started.
You should create a new admin account and delete this one.
- I want to use WebCalendar as an events calendar for
my organization. How do I set it up to do this?
- You will want to setup WebCalendar to use public access.
- Setup your settings.php file as a multi-user
system (see instructions).
- In System Settings, set "Allow public access" to "Yes."
- If you want people to be able to submit new events
through public access, set "Public access can add events"
to "Yes."
- If you set "Public access can add events" to "Yes",
set the setting for "Public access new events
require approval" to your liking. If you set this to "Yes,"
an admin user will need to approve any new events before
they will appear on the public access calendar.
- Login using one of the accounts you have setup.
Add a new event, and select "Public User" as one of the
participants.
- If you have enabled "Require event approvals" in your
System Settings, then you will need to approve the new
event. Choose the "Unapproved Events" at the bottom
of any page (you must be an admin user to access this).
You will be presented with a list of unapproved events
(for both the current user and for the Public User account).
Approve the new event for the Public User.
- Go to the Login page. You will see a "Access public calendar"
link that will bring you to the calendar for public access.
- By default, the index.php page should send users to
the public calendar.
- How can I add holidays to the calendar?
- There is no built-in support for holidays because it is
not necessary. You can add holidays into WebCalendar by importing
one of the many iCal holiday files that are freely available.
A good resource for free iCal files is
iCalShare
.
For example, the U.S. holiday ics file can be downloaded from:
http://icalshare.com/article.php?story=20020912105939521
If you don't want each individual user to have to import
the holiday calendar, you can use nonuser calendars.
First, make sure nonuser calendars are enabled in your
system settings. Then, from Admin->Users, you can
access nonuser calendars. Create a new nonuser calendar
(such as "usholidays"). Then, notify your users that they
can add this nonuser calendar as a layer to their own
calendar in order to see the holidays.
- Why are deleted events still present in the database?
- When you delete an event from your calendar, it is not
deleted from the database. Instead, it is marked as deleted.
This allows the system administrator access to information
even after it is deleted.
- Can I setup more than one public calendar?
- You cannot directly setup two public calendars. However,
there are two options for emulating this type of functionality:
- You can create global categories and point users to the calendar with only a certain category displayed.
- You can setup multiple NonUser calendars and enable
public access viewing of other users' calendars.
You can then link directly to the calendar of one of
the NonUser calendars, or you can
setup a view
that contains the calendar of one or more of the NonUser calendars.
- How do I change the title "Public Access" at the top of
the calendar?
- In the file translations/English-US.txt,
change the line that says "Public Access" to what you want
it to say on the right side.
Example:
Public Access: Foobar Event Calendar
- Can I embed WebCalendar as a component on another web page?
- WebCalendar is meant to be run as a standalone web application.
You can customize the appearance of WebCalendar to match your existing
site.
To do this, In System Settings, set both "Custom header" and
"Custom trailer" to "Yes" and press the "Edit" button to enter the
header and trailer content.
If you are looking to just include a list of upcoming events in one
of your web pages, you can use the upcoming.php page in
WebCalendar to do this. Edit the top of this file to configure options.
(These settings will likely move into System Settings in subsequent release.)
You can then use an iframe elsewhere on your web site as
in the example below:
<iframe height="250" width="300" scrolling="yes" src="upcoming.php"></iframe>
Include this HTML anywhere on any of your pages.
By default, the events from the public calendar will be loaded (so
you must have "Public Access" enabled in System Settings).
You can override this with another user's calendar.
(See upcoming.php for instructions on this.)
- How do I add a new translation?
-
It's a fairly simple process. If you've ever translated a C-based app
that used GNU's gettext tool, then you'll have no problem. The I18N
support was based on GNU's gettext . Here's what you need to do.
- look in the "translations" directory
- copy the English-US.txt file into what you'd like to call your
language data file. (e.g. cp English-US.txt French.txt)
- Now translate all the text to the _right_ of the ":" into the
new language. Do not alter the text to the left of the ":".
- When you're done making changes, move into the "tools" directory.
Run the check_translation.pl script on your new data file to make
sure you have all the needed translations.
(e.g. perl check_translation.pl French)
- Add the new language to both the $languages array and the
$browser_languages arrays defined in includes/config.php.
- Test it out...
- Post a copy of your translation (along with your changes to includes/config.php) to the SourceForge Patches for WebCalendar.
- How do I update an existing translation?
- Just open up the translation file in the translations directory
with your favorite text editor (like vi, vim, emacs, pico, Notepad, etc.).
In particular look for places where missing translations are indicated.
All missing translations should be marked with a
"<< MISSING >>" note.
and typically the English version of the translation will also be included on the following line (as in the example below):
# << MISSING >>
# Edit:
#
For some text, an abberviation may be used rather than the English text.
In those cases, the full text will be noted as in the following example:
# << MISSING >>
# custom-script-help:
# English text: Allows entry of custom Javascript or stylesheet text that
# will be inserted into the HTML "head" section of every page.
#
When you're done making changes, move into the tools directory.
Run the check_translation.pl script on your new data file to make
sure you have all the needed translations:
perl check_translation.pl French
Post a copy of your translation to the
SourceForge Patches for WebCalendar.
Troubleshooting
- I get error messages about undefined variables when I try to view any page.
- On newer versions of PHP, the default setting of PHP is to display
messages when an undefined variable is referenced. To prevent
these messages from being displayed, change the setting of error_reporting
in your php.ini file to be:
error_reporting = E_ALL & ~E_NOTICE
Alternately, you can disable any error messages from being displayed
in the browser and have them logged to a file. (See the comments
included in the php.ini file for instructions on how to do this.)
- I get errors when trying to add an event that contains a single quotation.
- WebCalendar is designed to work with PHP's
magic_quotes_gpc feature (configured in php.ini).
If you do not have this enabled (On in php.ini),
you may get errors when adding events.
In WebCalendar version 0.9.43 or later, you will always get an error
message telling you to update php.ini if magic_quotes_gpc
is set to Off.
TIP If you are using Apache
as your web server and if you cannot or do not want to enable
magic_quotes_gpc for your entire site, you can enable
it just for WebCalendar.
Create a .htaccess file in the toplevel WebCalendar
directory that contains a single line:
php_value magic_quotes_gpc 1
(For this to work with Apache, you must have the Apache
AllowOverride All directive enabled for the directory
where WebCalendar is installed.
Additionally, PHP must be running as an Apache module, not
a CGI.)
Note for Oracle and PostgreSQL: You must also change the value of
magic_quotes_sybase to On within the php.ini
settings.
- I get an error message from PHP saying "Call to undefined function: ..."
- This tells you that your version of PHP is missing something that
WebCalendar needs. If the function mentioned is a database login
function (ociplogin, mysql_pconnect, ibase_connect, pg_pconnect),
then you probably do not have the needed database support for your database
compiled into PHP.
If the function is not a database connect call, then check the
PHP manual
to see if the function requires a specific version of PHP. You
may have an out-dated version of PHP that requires upgrading.
- When I try and view certain pages, nothing happens for 30 seconds, then I get a time-out error.
- On slower or very busy servers, it can take some time for the server
to get all the events. Most PHP installations have a built-in timeout
out of 30 seconds and will interrupt any request that takes longer than
that. This is most likely to happen on the year-long custom report or
on the month view when layers are being used. If you have access,
you can increase the time-out value for PHP in the php.ini
file by changing the setting of the max_execution_time setting.
- I get an error message that says "Can't connect to local MySQL server through socket '/tmp/mysql.sock'."
- This is a PHP/MySQL configuration issue. The value of mysql.default_socket
in your php.ini file must match the value of socket in your
my.cnf file. Edit the php.ini file to fix this problem.
- I am not receiving any email messages from WebCalendar.
- WebCalendar sends two types of email messages:
Notifications* and Reminders*.
Check the following if you are not receiving any email:
- You have defined a valid SMTP server in your PHP configuration file
php.ini. (The setting is "SMTP" in the "mail_function" section.)
- In WebCalendar's System Settings, you have set the "Email Enabled" setting to "Yes".
- In WebCalendar's System Settings, make sure you have the "Default sender address"
to something.
Note:
Some mail system will reject mail that has a "From" address
that is a different domain from the originating SMTP server.
So, if your SMTP server is smtp.mydomain.com and your "Default sender address"
is calendar@someotherdomain.com, some mail systems may bounce the mail back.
- For a Notification, make sure you have the type of Notification
set to "Yes" in the user's Preferences.
- For a Reminder:
- Make sure you have "Event reminders" set to "Yes" in the user's Preferences.
- Make sure you have setup a cron job to periodically
run the send_reminders.php script.
- Some of the pages are displaying text in English rather than <insert your language here>
- The translations have been submitted at various points of WebCalendar development.
Some have not been updated to include newer features.
- The text that I entered in the Custom Event Fields is not being translated
to different languages.
- You will need to add an entry in each of the translation files for any text you add
into the Custom Event Fields.
- How do I get the most recent version of WebCalendar?
- You can download the latest public release from SourceForge's
file list for WebCalendar .
You can download the latest development code from the CVS server using
the instructions provided by SourceForge . (You will need a CVS client to do this.)
- How do I install a patch file listed on SourceForge's
list of WebCalendar patches ?
- Most patches are distributed as context diffs. That means they were produced using the UNIX diff command with the -C option. The patches are intended to be used with the GNU patch program. This program is standard on most Linux systems and can be obtained as part of the Cygwin package for Windows. Mac OS X will have the patch program installed if they install the developer tools CD.
- I forgot/lost my admin password. How can I reset it?
- The easiest way is to admin a new admin user and then use that
new user to reset the password for your old admin account.
Assuming you have deleted the original 'admin' login, you can use
the following SQL to insert a new admin user into the database:
INSERT INTO webcal_user ( cal_login, cal_passwd, cal_lastname,
cal_firstname, cal_is_admin ) VALUES
( 'admin', '21232f297a57a5a743894a0e4a801fc3', 'Administrator',
'Default', 'Y' );
This will add a user with login 'admin' and password 'admin' to the database.
If you still have a user named 'admin', then replace 'admin' in the above
SQL with a different username.
- I get a database error indicating table webcal_config does not exist.
- This is the first table that WebCalendar tries to access, so it
typically means one of the following:
- You have not created the database tables as described in the instructions
- You have the wrong database name specified in your
includes/settings.php file
Getting Help
Try the Help/Troubleshooting forum for WebCalendar, hosted at SourceForge.net:
https://sourceforge.net/forum/forum.php?forum_id=11588
If you encounter a bug, please check the
list of open and pending bugs .
If you do not see anything similar, submit a new bug.
Licensing
WebCalendar is distributed under the open source
GNU General Public License .
If you have questions about this license, please
read their GPL FAQ .
Glossary
- Activity Log
- A summary of recent updates to calendar data
- Assistant
- A calendar user that has been designated by another calendar user
(the Boss) to help manage their calendar
- Boss
- A calendar user that has designated another calendar user
(the Assistant) to help manage his calendar
- External User
- A calendar participant that does not have a calendar user account
- Group
- A mechanism of dividing up a large set of users into smaller sets of users
- Layer
- A function that allows a user to overlay another user's calendar
on top of his own calendar so that the standard day, week and month
pages show both his own and the layered user's events
- LDAP
- LDAP (Lighweight Directory Access Protocol) is an Internet protocol
used to maintain user directories
- Multi-User Mode
- When WebCalendar is configued in Multi-User Mode,
there can be multiple user accounts, each with his
own calendar. Unless Public Access is enalbed, all users
will be required to login before they can access the system.
- NIS
- NIS (Network Information Service) is a UNIX-based user authentication
system for managing user directories in a network
- NonUser Calendar
- A participant to a calendar event that is not a calendar user. This is typically used either as a resource (conference room,
laptop computer) that needs to be shared or as a shared calendar
that other users overlay onto their own calendar using layers (company-wide calendar,
holiday calendar, etc.)
- Notification
- An email message that is sent when an event is added, removed
or updated in the user's calendar by another user
- Preferred View
- The standard page (day, week, month or year) that will
be presented to the user after logging in
(set in user Preferences)
- Public Access
- A System Setting that will allow anonymous users
to access the calendar.
See the simple instructions for
setting this up in the FAQ section.
(Requires WebCalendar to be configued in Multi-User Mode).
- Reminder
- An email message that is sent before an event to remind
the participant
- Single-User Mode
- When WebCalendar is configued in Single-User Mode,
there is no concept of users. You will be managing a single
calendar and no login will be required.
Anyone accessing this calendar will have full privileges to
view, add, edit and delete all events.
- Time Interval
- The amount of time each "block" will represent in
either the day or week view
(set in user Preferences)
- View
- A customized page that presents the events of selected users
- Work Hours
- The default hours to show in the week and day view where
events are displayed in blocks of time (set in
user Preferences)
Appendix A: Using phpMyAdmin
If you have phpMyAdmin
installed and configured to manage your MySQL database, use the
following steps to setup WebCalendar.
(The following information is based on phpMyAdmin version 2.6.1.)
- On the initial phpMyAdmin page, under the "MySQL" heading, the first
option should be "Create new database." Enter the name you have
chosen for the database and press the "Create" button.
(The default database name used by WebCalendar is "intranet".)
After pressing the "Create" button, it should say:
"Database <your database name here> has been created."
- Click on the home icon (the small house) in the left-side
navigation. This will bring you back to your phpMyAdmin home page.
- (Optional) Create new MySQL user. If you already have
a MySQL login that you would like to use, you can skip this step.
- Click on the "Privileges" link under the "MySQL" heading.
- Below any existing users listed, click on the link "Add a new User."
- Fill in the details of your new database user.
The default username for WebCalendar is "webcalendar"
with a password of "webcal01".
Leave the "Host" field set to "Any host".
- From the list of "Global privileges", be sure to select:
SELECT, INSERT, UPDATE, DELETE, FILE, CREATE, ALTER, INDEX, DROP
- Click on the "Go" button.
- You should see a page that says "You have added a new user."
- Click on the "Databases" tab at the top of the page.
- From the list of databases on the page, click on the name
of the database that you created.
- Click on the "SQL" tab at the top of the page.
- At the bottom of the page, there is an area to upload a SQL file.
Click on the "Browse" button and select the tables-mysql.sql
file in the WebCalendar toplevel directory.
Then, press the "Go" button.
- The top of the page should say "Your SQL-query has been executed
successfully."
- You have now finished creating the WebCalendar database tables.
Appendix B: Setting Up Reminders on Windows
You have two options to choose from when setting up email
reminders on a Windows platform.
You can either install a cron package for Windows,
or you can use the Windows Task Scheduler.
Installing a Cron Package
If you install a cron package for Windows, you will need to setup
to setup a cron job.
(UNIX cron is a tool for used to run tasks as specified times anywhere
from every minute to once a year.)
First, you should create a sendreminders.bat file
that contains a single line:
C:\your\path\to\php.exe C:\your\path\to\webcalendar\tools\send_reminders.php
You can place this sendreminders.bat file anywhere on your
file system.
Next, you need to setup the cron job.
The crontab entry should look like
the following (replace with the correct path to your
newly created sendreminders.bat file):
1 * * * * C:\your\path\to\sendreminders.bat
The "1 * * * *" will tell the cron schedule to run this task
at 1 after the hour all day long (12:01am, 1:01am, 2:01am, etc.)
If you only want to run it once per day, you could use:
1 4 * * * C:\your\path\to\sendreminders.bat
This would tell the cron scheduler to run the task at 4:01am
every day.
For more information about the syntax of cron, check the documentation
for the package you have installed or
view the UNIX man page for crontab
(like this one).
There are many cron packages for Windows available.
Below is a list of packages to choose from.
(Note: use at your own risk. These links are provided
for information only.)
Using the Windows Task Schedule
Follow the steps listed below to setup a new task
in the Windows Task Scheduler.
(These instructions were created with Windows XP Professional.
Other versions of Windows might be different.)
- Create a new batch file called sendreminders.bat.
The contents of this file should be a single line:
C:\your\path\to\php.exe C:\your\path\to\webcalendar\tools\send_reminders.php
- On Windows XP, go to Control Panel
- Double-click on "Scheduled Tasks."
This brings up a window that says "Scheduled Task Wizard"
- Click on "Browse..."
- Select the location of your newly created
sendreminders.bat file.
- Click on "Open"
- Change the name of the task. "WebCalendar Reminders" is a good name.
- Select how often to perform this task. Select "Daily."
- Click on "Next"
- Select the start time, then click "Next".
If you are planning on sending out reminders throughout the
day, pick a time shortly after midnight.
- Enter your user password as required. Click on "Next."
- Select the checkbox "Open advanced properites".
- Click on "Finish."
- Under the "Schedule" tab, click on "Advanced."
- Click on "Repeat Task" and fill in the details of how often
the job should run.
For example, you can set it to run "every 15 minutes", then
click on "until" and set that time to 11:30pm.
Appendix C: Displaying Upcoming Events on Your Site
If you would like to list upcoming events somewhere on a page on your site
(someplace other than the WebCalendar pages),
you can use the upcoming.php page to do this.
This page is intended to be included in other pages using the
iframe tag.
You may need to modify some of the variables near the top of
upcoming.php with a text editor:
| $public_must_be_enabled |
Specifies if Public Access must be enabled in System Settings
for this page to be viewed.
Default setting: false
|
| $display_link |
Specifies if events should have a link to the URL
within WebCalendar to view the event.
Default setting: true
|
| $link_target |
Specifies the name of the window that be used for
the link target.
Default setting: _top
|
| $numDays |
Specifies how many days of events should be listed.
Can override this by passing "num" in within the URL
with "upcoming.php?num=60"
Default setting: 30
|
| $maxEvents |
Specifies the maximum number of events to list.
Default setting: 10
|
| $username |
The login of the calendar to display upcoming events for.
If you want to see upcoming events for user login "joe",
then you would change this to "joe".
Default setting: __public__ (The public calendar)
|
| $allow_user_override |
Specifies whether the calendar user can be specified in the URL
(in which case the $username setting will be ignored) using
a URL like "upcoming.php?user=joe".
Default setting: true
|
| $load_layers |
Specifies if the calendar user's layers should also be
included in the upcoming events.
Note: Layers must be enabled in the user's preferences.
Default setting: true
|
| $cat_id |
Specifies a category id to filter events on.
Note: Categories must be enabled in System Settings.
Default setting: (empty)
|
Below is an example of how you would include upcoming.php
in a simple HTML page.
<html><head><title>ACME Home Page</title></head>
<body>
<h1>Welcome to the ACME Home Page</h1>
<h2>News</h2><
p>No news....</p>
<h2>Upcoming Events</h2>
<iframe src="upcoming.php" width="400" height="400" name="califrame" />
</body>
</html>
TIP
The W3 Schools site provides documentation
about the different options that you can use
with the iframe tag.
Appendix D: How To Configure For LDAP
Configuring WebCalendar to use an existing LDAP directory is fairly
simple. It is know to work with OpenLDAP and Novell Edirectory and
should work with other systems as well. Note:
If you use LDAP, the group functionailty of WebCalendar does not yet work.
To configure WebCalendar to use LDAP, do the following:
- Configure settings.php
- Configure includes/user-ldap.php
The first step is to set WebCalendar to use LDAP authentication in
settings.php. Instructions on to do this can be found in the
Application Setup section above.
In summary, the following should be set:
use_http_auth = false
user_inc = user-ldap.php
The next step is a little more work and involves editing the
includes/user-ldap.php file with a text editor. You will have
to set several configuration variables. If you don't know what to set
the variables to, consult your LDAP system administrator. Documentation
exists for all variables in the file. Finally, users have gotten LDAP
working with OpenLDAP and Novell Edirectory by just changing the
following:
| $ldap_server |
FQDN or IP address of the LDAP server (or localhost).
ex. 'ldapserver.company.com'
|
| $ldap_base_dn |
Specifies the base DN used to search for users
ex. 'ou=people,dc=company,dc=com' or 'o=context,ou=subcontext'
|
| $ldap_admin_group_name |
Specifies a group (complete DN) with admin rights for WebCalendar
You might have to create one in LDAP
ex. 'cn=it,ou=group,dc=company,dc=com'
|
Using SSL with LDAP
If the LDAP server will accept connections over SSL, simply add 'ldaps://'
to the beginning of $ldap_server.
Example: ldaps://ldapserver.company.com
Using TLS with LDAP
If the LDAP server is set up to use TLS, just set $ldap_start_tls = true.
|
