| Home | Gifts |
mailnotify is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run.
%NOTIFYTOPIC%
Tip: Instead of subscribing here, it is easier to "watch" topics of interest. Watching topics gives you the choice of immediate notification or digest notification.
* subscriber [ : topics ]
Where subscriber can be a WikiName, an E-mail address, or a
group name. If subscriber contains any characters that are not legal in
an email address, then it must be enclosed in 'single' or "double" quotes. Please note that the guest user TWikiGuest does not have an email address mapped to it, and will never receive email regardless of the configuration of that user.
topics is an optional space-separated list of topics:
* in a topic name, where it is treated as a wildcard character
. A * will match zero or more other characters - so, for example, Fred* will match all topic names starting with Fred, *Fred will match all topic names ending with Fred, and * will match all topic names.
* daisy.cutter@flowers.comSubscribe Daisy to all changes to topics that start with
Web.
* daisy.cutter@flowers.com : Web*Subscribe Daisy to changes to topics starting with
Petal, and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers
* DaisyCutter: Petal* (1) WeedKillers (3) Pretty*FlowersSubscribe StarTrekFan to changes to all topics that start with
Star except those that end in Wars, sInTheirEyes or shipTroopers.
* StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopersSubscribe Daisy to the full content of NewsLetter whenever it has changed
* daisy@flowers.com: NewsLetter?Subscribe buttercup to NewsLetter and its immediate children, even if it hasn't changed.
* buttercup@flowers.com: NewsLetter! (1)Subscribe GardenGroup (which includes Petunia) to all changed topics under AllnewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter, which she would normally get as a member of GardenGroup:
* GardenGroup: AllNewsLetters? (3) * petunia@flowers.com: - ManureNewsLetterSubscribe
IT:admins (a non-TWiki group defined by a custom user mapping) to all changes to Web* topics.
* 'IT:admins' : Web*In addition to single quotes ('), double quotes (") do the same job for a non-TWiki group. A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes that topic once (though they will still receive individual mails for news topics). If a group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.
Warning: Because an email address is not linked to a user name, there is no way for TWiki to check access controls for subscribers identified by email addresses. A subscriber identified by an email address alone will only be sent change notifications if the topic they are subscribed to is readable by guest users. You can limit what email addresses can be used in WebNotify, or even block use of emails altogether, using the {MailerContrib}{EmailFilterIn} setting in =configure.
Tip: List names in alphabetical order to make it easier to find the names.
Note for System Administrators: Notification is supported by an add-on to the TWiki kernel called the MailerContrib. See the MailerContrib topic for details of how to set up this service.
Note: If you prefer a news feed, point your reader to WebRss (for RSS 1.0 feeds) or WebAtom (for ATOM 1.0 feeds). Learn more at WebRssBase and WebAtomBase, respectively.
You can also use %USERSWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring {MainWebName} in configure.
SEARCH. The number of topics listed by the limit parameter.:
%SEARCH{
".*"
web="TWiki"
type="regex"
nosearch="on"
sort="modified"
reverse="on"
limit="50"
}%
%SEARCH{}%.
SEARCH:
%SEARCH{
"\.*"
scope="topic"
type="regex"
nosearch="on"
}%
You can create a WebStatistics link using TWikiVariables with %STATISTICSTOPIC%
TWiki also generates overall site usage statistics in Main.SiteStatistics (do not create that page, it is created automatically based on SiteStatisticsTemplate). On a monthly basis, the following items are recorded using system data and TWiki log data across all webs: Number of webs, number of topics, number of attachments, number of topic views, number of topic updates, number of files uploads, data size, pub size, disk use, number of users, number of groups, number of plugins installed compared to total number of plugins available, and the 10 top contributors.
{Log}{view}, {Log}{save} and {Log}{upload} are set in configure. This will generate log file entries (see below).
twiki/bin/statistics script from a cron job - once a day is recommended. This will update the SiteStatistics and the WebStatistics topics in all webs.
nobody or www-data. Example crontab entry: 0 0 * * * (cd /path/to/twiki/bin; ./statistics >/dev/null 2>&1)
nobody : Run the utility twiki/tools/geturl.pl in your cron job and specify the URL of the twiki/bin/statistics script as a parameter. Example: 0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
geturl.pl will do a TWiki CGI request as the TWikiGuest user, so if you use this workaround, the WebStatistics topics you are updating will have to be writable by TWikiGuest.
cd twiki/bin; ./statistics -logdate 2011-05 -webs TWiki,Sandbox
{Stats}{DisableInvocationFromBrowser} config parameter is false (it's false in this installation), the twiki/bin/statistics script can also be executed as a CGI script - just enter the URL in your browser. Examples: /bin/statistics
/bin/statistics/Main
/bin/statistics/Main?logdate=2024-11
/bin/statistics?logdate=2024-11;webs=ProjectX,ProjectY,ProjectZ
| Topic | Column and part | Configuration parameter | Default |
|---|---|---|---|
| WebStatistics of webs | Affiliation breakdown in "Topic views", "Topic saves", and "File uploads" columns | {Stats}{TopAffiliation} |
10 |
| "Most popular topic views" column | {Stats}{TopViews} |
10 | |
| "Top viewers" column | {Stats}{TopViewers} |
10 | |
| "Top contributors for tpoic save and uploads" column | {Stats}{TopContrib} |
10 | |
| Main.SiteStatistics | The list of webs viewed the most number of times in the "Webs Viewed" column | {Stats}{SiteTopViews} |
0 |
| The list of webs updated the most number of times in the "Webs Updated" column | {Stats}{SiteTopUpdates} |
0 | |
| Affiliation breakdown in "Topic Views", "Topic Saves", and "File Uploads" columns | {Stats}{SiteTopAffiliation} |
10 | |
| "Top Viewers" column | {Stats}{SiteTopViewers} |
10 | |
| "Top Contributors" column | {Stats}{SiteTopContrib} |
10 |
| Month: | Topic views: |
Topic saves: |
File uploads: |
Most popular topic views: |
Top viewerss: | Top contributors for topic save and uploads: |
|---|---|---|---|---|---|---|
| 2013-08 | 10325 (150 unique users) 6921 R&D 1736 Operation 927 Sales 623 Management 98 Unknown |
7 (3 unique users) 7 R&D |
3 (1 unique users) 3 R&D |
6941 WebHome 872 WebSearch 848 ToolSiteMap 376 ToolDashboard 223 WebSearchAdvanced 185 ContRequests 127 WebTopicList 89 ToolPersonalWebs 72 ToolMasquerading 70 TWikiAdminUser |
525 PeterThoeny 49 MahiroAndo 9 HdeyoImazu |
5 HdeyoImazu 1 MahiroAndo 1 PeterThoeny |
getAffiliation($cUID) object method in the current user mapping handler. It's supposed return the affiliation (division, department, etc.) of the $cUID. If the affiliation is unknown, it returns undef.
{Stats}{Breakdown} configuration papameter true by putting the following line in lib/LocalSite.cfg.
$TWiki::cfg{Stats}{Breakdown} = 1;
{Stats}{ExcludedWebRegex} config parameter as follows.
$TWiki::cfg{Stats}{ExcludedWebRegex} = '^(Trash(x\d+x)?\d*|Sandbox\d*)\b';
You may wonder when this is needed.
There are webs not worth updating WebStatistics such as the Trash web. When a web is deleted, it becomes a subweb of the Trash web. By default, not only the Trash web but also subwebs of the Trash web are subject to WebStatistics update.
On a large TWiki site, you may have dozens of Trash webs - you may rotate Trash webs and you may be UsingMultipleDisks (each disk requires its own Trash - e.g. Trashx1x and Trashx2x). If you have Trash, Trash1, ..., Trash10 for rotation and if you use 3 disks for TWiki, you end up having 33 Trashes.
statistics script every day, you increase the revision of each WebStatistics by one every day. If a topic has hundreds of revision, some operations such as getting the original creator of the topic takes long.
There is an option to prevent the boundless growth of WebStatistics.
If you set $TWiki::cfg{Stats}{TopicPerYear} true, the statistics script writes the result to WebStatisticsYYYY where YYYY is the current year (e.g. WebStatistics2024) instead of WebStatistics. The parameter is false by default. is installed, viewing WebStatistics causes redirection to the WebStatisticsYYYY of the year. Otherwise, WebStatistics shows links to WebStatisticsYYYY topics.
{Stats}{TopicPerYear} to true but before you run the statistics script, you should run twiki/tools/switch2yearlystats to rename WebStatistics of all webs to WebStatisticsYYYY of the year. In case WebStatistics is not in the same format as its current template, it's renamed to WebStatistics0000.
{Stats}{TopicPerYear} is true: twiki/tools/switch2yearlystats renames Main.SiteStatistics to Main.SiteStatisticsYYYY of the year or Main.SiteStatistics0000.
statistics script doesn't work well.
By running tools/convert_stats_twiki6 after upgrade, all statistics topics are converted for the current version of statistics.
{Stats}{SiteTopContrib}.
Prior to TWiki 6.0, it was specified by {Stats}{TopContrib}.
If you have a custom {Stats}{TopContrib} value, you need to set {Stats}{SiteTopContrib} as well. Otherwise, the number of "Top Contributors" on SiteStatistics becomes the default value, which is 10.
log<year><month>.txt
twiki/logs/log202411.txt
| <time in GMT> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
| 17 Nov 2024 - 07:32 | Main.TWikiGuest | view | TWiki.WebRss | | 66.124.232.02 |
| Script | Action name | Extra info |
|---|---|---|
| attach | attach | when viewing attach screen of previous uploaded attachment: filename |
| changes | changes | |
| edit | edit | when editing non-existing topic: (not exist) |
| login, logon, attach, edit, register, rest, view, vewfile | sudologin, sudologout | Login name of administrator user who is logging in or out |
| manage | changepasswd | Login name of user who's password is changed |
| mdrepo | mdrepo | operation and its arguments |
| rdiff | rdiff | higher and lower revision numbers: 4 3 |
| register | regstart | WikiUserName, e-Mail address, LoginName: user attempts to register |
| register | register | E-mail address: user successfully registers |
| register | bulkregister | WikiUserName of new, e-mail address, admin ID |
| rename | rename | when moving topic: moved to Newweb.NewTopic |
| rename | renameweb | when renaming a web: moved to Newweb |
| rename | move | when moving attachment: Attachment filename moved to Newweb.NewTopic |
| resetpasswd | resetpasswd | Login name of user who's password is reset |
| save | save | when replacing existing revision: repRev 3 when user checks the minor changes box: dontNotify when user changes attributes to an exising attachment: filename.ext |
| save | cmd | special admin parameter used when saving |
| search | search | search string |
| upload | upload | filename |
| view | view | when viewing non-existing topic: (not exist) when viewing previous topic revision: r3 |
| viewfile | viewfile | Attachment name and revision: File.txt, r3 |
Net::SMTP module if it is installed on your system. Set this with the {SMTP}{MAILHOST} setting in configure.
You can define a separate {SMTP}{SENDERHOST} configure setting to set the mail sender host - some SMTP installations require this.
If you are using SELinux (Security-Enhanced Linux) you might need to configure it to allow TWiki to send e-mails: $ sudo setsebool -P httpd_can_sendmail on $ sudo setsebool -P httpd_can_network_connect on
sendmail, if the Net::SMTP module is not installed or not functioning properly. Set the program path in {MailProgram} and set {SMTP}{MAILHOST} to an empty value in configure.
The notify e-mail uses the default changes.tmpl template, or a skin if activated in the TWikiPreferences.
mailnotify also relies on two hidden files in each twiki/data/Web directory: .changes and .mailnotify. Make sure both are writable by your web server process. .changes contains a list of changes; go ahead and make this empty. .mailnotify contains a timestamp of the last time notification was done.
cron table so that mailnotify is called in an interval of your choice. Please consult man crontab of how to modify the table that schedules program execution at certain intervals. Example:
% crontab -e 0 1 * * * (cd /path/to/twiki; perl -I bin tools/mailnotify -q)The above line will run mailnotify nightly at 01:00. The
-q switch suppresses all normal output. Details at MailerContrib.
For ISP installations: Many ISPs don't allow hosted accounts direct cron access, as it's often used for things that can heavily load the server. Workaround scripts are available.
On Windows: You can use a scheduled task if you have administrative privileges. TWiki:Codev/CronTabWin is a free scheduler for Windows.
- crontab for Windows
, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.KennethLavrsen, TWiki:Main.SvenDowideit
| Revision r20 - 2013-10-13 - 10:29:54 - TWikiContributor | Edit |