Index: .hgignore =================================================================== --- .hgignore (revision 3) +++ .hgignore (revision 0) @@ -4,3 +4,2 @@ *.pyc *.db -dist/ Index: THORS =================================================================== --- AUTHORS (revision 16) +++ (revision ) @@ -1,1 +1,0 @@ -Francisco de Borja Lopez Rio Index: STALL =================================================================== --- INSTALL (revision 16) +++ (revision ) @@ -1,111 +1,0 @@ -Mailjam - installation instructions -=================================== - -.. contents:: - -First, install dependencies ---------------------------- - -So far, the only dependency you will need in order to run mailjam is Python [1]_ - -Mailjam has been tested with python *2.7.x*, but it should work with versions -*2.6.x* too. - -Please, refer to your operating system package system documentation to learn -more about how to install python. - -Second, install Mailjam ------------------------ - -Installing using pip -++++++++++++++++++++ - -You can install Mailjam using pip [2]_:: - - pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -.. note:: - - Mailjam has not been recorded/uploaded to pypi [3]_ yet, so, in order - to install it using pip you will have to provide the URL for the public - Mailjam repo. - -Installing using easy_install -+++++++++++++++++++++++++++++ - -You can not install Mailjam using easy_install [4]_ yet (until we do -record/upload it to pypi) - -Installing inside a virtualenv -++++++++++++++++++++++++++++++ - -You can install Mailjam inside a virtualenv [5]_. Just create a virtualenv:: - - virtualenv /path/to/your/env - -Then activate it:: - - source /path/to/your/env/bin/activate - -.. note:: - - If your shell is **csh**/**tcsh** remember you have to activate the - environment this way:: - - source /path/to/your/env/bin/activate.csh - -And, once the environment has been activated, use pip to install Mailjam:: - - env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -Installing from sources -+++++++++++++++++++++++ - -Releases -******** - -There are no releases yet. You will have to install it from the repository. - -From repository -*************** - -The source code of Mailjam is hosted in bitbucket [6]_. In order to grab -the latest sources you need Mercurial [7]_. - -To get a copy of the sources, just *clone* the repository:: - - hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo - -Then, go inside the *mailjam-repo* directory and run:: - - python setup.py install - -.. warning:: - - If you want to install it *system-wide*, probably you will need *root* - privileges (check your OS documentation to learn more about how to get - *root* privileges - for example using sudo [8]_) - -Setting up Mailjam ------------------- - -TBW - -Running Mailjam ---------------- - -TBW - -Running tests (developers only) -------------------------------- - -TBW - -.. [1] http://python.org -.. [2] http://www.pip-installer.org/en/latest/index.html -.. [3] http://pypi.python.org/pypi -.. [4] http://peak.telecommunity.com/DevCenter/EasyInstall -.. [5] http://www.virtualenv.org/en/latest/index.html -.. [6] https://bitbucket.org/codigo23/mailjam -.. [7] http://mercurial.selenic.com -.. [8] http://sudo.ws Index: CENSE =================================================================== --- LICENSE (revision 3) +++ (revision ) @@ -1,27 +1,0 @@ -Copyright (c) 2012, Soluciones Informaticas Codigo23 S.L.U. -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - - * Neither the name of Codigo23 nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. -IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, -INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, -BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE -OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED -OF THE POSSIBILITY OF SUCH DAMAGE. Index: NIFEST =================================================================== --- MANIFEST (revision 34) +++ (revision ) @@ -1,19 +1,0 @@ -# file GENERATED by distutils, do NOT edit -README -setup.py -bin/mailjam-cli -bin/mailjam-mta -bin/mailjam-server -bin/rc.d/mailjam -conf/mailjam-cli.conf -conf/mailjam-mta.conf -conf/mailjam.conf -mailjam/__init__.py -mailjam/cli.py -mailjam/config.py -mailjam/daemon.py -mailjam/models.py -mailjam/mta.py -mailjam/storage.py -mailjam/tools.py -mailjam/webapp.py Index: ADME =================================================================== --- README (revision 30) +++ (revision ) @@ -1,50 +1,0 @@ -Mailjam - Mailing lists manager -=============================== - -.. contents:: - - -Introduction ------------- - -Mailjam is a mailing list manager. With it you will be able to create mailing -lists and manage them. - -Mailjam requires a functional MTA [1]_ (Mailjam has been successfully tested -with sendmail [2]_ and postfix [3]_ but it should work with other MTA software) - -Overview --------- - -.. image:: mailjam/raw/b1d527287347/docs/src/mailjam_architecture.png - :alt: Scheme of the architecture behind Mailjam - -Mailjam has been designed following a **multi-component structure**. There is -**a daemon** that manage the mailing lists and members information in a storage -backend and there are **different kinds of clients** (currently, three of them) -that **interact with the daemon using a XMLRPC link**. - -More information here: http://readthedocs.org/docs/mailjam/en/latest/overview.html - -Install -------- - -For installation instructions, please check the INSTALL file, or the -documentation inside the docs/ subdirectory. - -You can read the installation instructions here: -http://readthedocs.org/docs/mailjam/en/latest/install.html - -Documentation -------------- - -The official documentation is available in the docs/ subdirectory, and -you can read the docs online too (thnx to readthedocs.org [4]_): - -http://mailjam.readthedocs.org - - -.. [1] http://en.wikipedia.org/wiki/Message_transfer_agent -.. [2] http://sendmail.org -.. [3] http://www.postfix.org -.. [4] http://readthedocs.org Index: ADME.rst =================================================================== --- README.rst (revision 35) +++ (revision ) @@ -1,50 +1,0 @@ -Mailjam - Mailing lists manager -=============================== - -.. contents:: - - -Introduction ------------- - -Mailjam is a mailing list manager. With it you will be able to create mailing -lists and manage them. - -Mailjam requires a functional MTA [1]_ (Mailjam has been successfully tested -with sendmail [2]_ and postfix [3]_ but it should work with other MTA software) - -Overview --------- - -.. image:: mailjam/raw/b1d527287347/docs/src/mailjam_architecture.png - :alt: Scheme of the architecture behind Mailjam - -Mailjam has been designed following a **multi-component structure**. There is -**a daemon** that manage the mailing lists and members information in a storage -backend and there are **different kinds of clients** (currently, three of them) -that **interact with the daemon using a XMLRPC link**. - -More information here: http://readthedocs.org/docs/mailjam/en/latest/overview.html - -Install -------- - -For installation instructions, please check the INSTALL file, or the -documentation inside the docs/ subdirectory. - -You can read the installation instructions here: -http://readthedocs.org/docs/mailjam/en/latest/install.html - -Documentation -------------- - -The official documentation is available in the docs/ subdirectory, and -you can read the docs online too (thnx to readthedocs.org [4]_): - -http://mailjam.readthedocs.org - - -.. [1] http://en.wikipedia.org/wiki/Message_transfer_agent -.. [2] http://sendmail.org -.. [3] http://www.postfix.org -.. [4] http://readthedocs.org Index: n/mailjam-cli =================================================================== --- bin/mailjam-cli (revision 23) +++ (revision ) @@ -1,21 +1,0 @@ -#!/usr/bin/env python -# -# Run the Mailjam CLI client - -import argparse -from mailjam.cli import CLIClient - -msg = 'mailjam-cli: Mailing lists CLI client' -parser = argparse.ArgumentParser(description=msg) -parser.add_argument('-c', '--config', action='store', dest='config', - help='Set the path to a valid mailjam cli client configuration file') -parser.add_argument('-v', '--version', action='version', - version='mailjam cli client 0.1.0') - -if __name__ == '__main__': - results = parser.parse_args() - if results.config: - cli_client = CLIClient(configfile=results.config) - else: - cli_client = CLIClient() - cli_client.cmdloop() Index: n/mailjam-mta =================================================================== --- bin/mailjam-mta (revision 23) +++ (revision ) @@ -1,31 +1,0 @@ -#!/usr/bin/env python -# -# Run the Mailjam MTA client - -import argparse -from mailjam.mta import MTAClient - -msg = 'mailjam-mta: Mailing lists MTA client' -parser = argparse.ArgumentParser(description=msg) -parser.add_argument('-c', '--config', action='store', dest='config', - help='Set the path to a valid mailjam mta client configuration file') -parser.add_argument('-v', '--version', action='version', - version='mailjam mta client 0.1.0') -parser.add_argument('-a', '--address', action='store', dest='address', - required=True, - help='Set the address of the mailing list we want to manage') - -parser.add_argument('-i', '--input', type=argparse.FileType('r'), - default='-', required=True, dest='input', - help="Pass the raw email to be send to the mailing list, Use - to allow incoming raw mails from a pipe") - -if __name__ == '__main__': - results = parser.parse_args() - if results.config: - mta_client = MTAClient(address=results.address, - configfile=results.config) - else: - mta_client = MTAClient(address=results.address) - mta_client.get_raw_email(results.input.read()) - mta_client.run() - Index: n/mailjam-server =================================================================== --- bin/mailjam-server (revision 21) +++ (revision ) @@ -1,23 +1,0 @@ -#!/usr/bin/env python -# -# Run the Mailjam XML-RPC server -# - -import argparse - -from mailjam.daemon import MailjamDaemon - -msg = 'mailjam-server: Mailing lists management server' -parser = argparse.ArgumentParser(description=msg) -parser.add_argument('-c', '--config', action='store', dest='config', - help='Set the path to a valid mailjam configuration file') -parser.add_argument('-v', '--version', action='version', - version='mailjam server 0.1.0') - -if __name__ == '__main__': - results = parser.parse_args() - if results.config: - daemon = MailjamDaemon(configfile=results.config) - else: - daemon = MailjamDaemon() - daemon.run() Index: n/rc.d/mailjam =================================================================== --- bin/rc.d/mailjam (revision 32) +++ (revision ) @@ -1,113 +1,0 @@ -#!/bin/sh -# -# Generic init.d/rc.d script to invoke mailjam daemon properly -# -# Use this only if there is no specific startup script for your OS -# -# This file is released under the BSD license, see LICENSE for -# more information. -# -# Francisco de Borja Lopez Rio - -# Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -# - -mailjam_bin_path=/usr/local/bin -mailjam_server=${mailjam_bin_path}/mailjam-server -# check if that binary exists, if not, try to find where it is -if [ ! -x "${mailjam_server}" ] -then - mailjam_server=`which mailjam-server` -fi - -#mailjam_etc_path=/usr/local/etc -mailjam_etc_path=/Users/wu/codigo23/devel_python/MailingList/osx/env/etc -mailjam_conf=${mailjam_etc_path}/mailjam.conf - -access_log=`grep accesslog etc/mailjam.conf |cut -f 2 -d '='|sed 's/^[ \t]*//'` -pidfile=/tmp/mailjam.pid - -rm=`which rm` -# pgrep=`which pgrep` -pkill=`which pkill` -kill=`which kill` -killall=`which killall` - -usage() { - echo "Usage: $0 [ start|stop|restart ]" -} - -start_mailjam_server() { - echo "Starting Mailjam daemon" - if [ -x "${mailjam_server}" ] - then - if [ -f "${mailjam_conf}" ] - then - ${mailjam_server} -c ${mailjam_conf} > ${access_log} 2>&1 & - else - ${mailjam_server} > ${access_log} 2>&1 & - fi - # save the pidfile - echo $! > ${pidfile} - else - echo "ERROR - mailjam-server not found" - fi -} - -check_then_start_mailjam_server() { - # check if there is another daemon running, call the start function - # if needed - if [ -f "${pidfile}" ] - then - mailjam_pid=`head -n 1 ${pidfile}|cut -f 1 -d " "` - ps -p ${mailjam_pid} > /dev/null - if [ $? -eq 0 ] - then - echo "Another mailjam server is already running (pid ${mailjam_pid})" - else - start_mailjam_server - fi - else - start_mailjam_server - fi -} - -stop_mailjam_server() { - echo "Stopping Mailjam daemon" - if [ -f "${pidfile}" ] - then - # if there is a pidfile, try to kill the process by its pid - ${kill} -15 `head -n 1 ${pidfile}|cut -f 1 -d " "` - ${rm} ${pidfile} - else - # if there is no pidfile, try to locate the pid and kill it. - # FIXME: This will not work if the process is not "mailjam-server" - # but "python mailjam-server" - if [ -x "${pkill}" ] - then - ${pkill} -15 ${mailjam_server} - else - if [ -x "${killall}" ] - then - ${killall} -15 "${python_path} ${mailjam_server}" - else - echo "ERROR - can't stop the mailjam server" - fi - fi - fi -} - -case "$1" in - 'start') - check_then_start_mailjam_server - ;; - 'stop') - stop_mailjam_server - ;; - 'restart') - stop_mailjam_server - sleep 2 - start_mailjam_server - ;; - *) - usage -esac Index: n/run_tests =================================================================== --- bin/run_tests (revision 16) +++ (revision ) @@ -1,21 +1,0 @@ -#!/usr/bin/env python -# -# Run the tests for the mailjam package - -import os, shutil, sys, unittest - -try: - from mailjam.tests import * -except ImportError: - sys.path.append(os.path.join(os.path.dirname(__file__), '../')) - try: - from mailjam.tests import * - except ImportError: - raise SystemExit('Could not find mailjam on your filesystem') - -try: - unittest.main() -finally: - # FIXME: hardcoded path to the tmp directory, we should read this path - # from mailjam/tests/mailjam.conf - shutil.rmtree('/tmp/mailjam-tests') Index: nf/mailjam-cli.conf =================================================================== --- conf/mailjam-cli.conf (revision 27) +++ (revision ) @@ -1,16 +1,0 @@ -# -# mailjam-cli.conf - Mailjam CLI client configuration file -# - -[server] -address = localhost -port = 9876 -uri = http://%(address)s:%(port)s -ssl = false -# FIXME: This parameter here is a nonsense, but right now we have to pass -# it as an argument when adding mailing lists (BUG!) -configfile = etc/mailjam.conf - -[history] -enabled = true -path = ~/.mailjam/cli/history Index: nf/mailjam-mta.conf =================================================================== --- conf/mailjam-mta.conf (revision 16) +++ (revision ) @@ -1,13 +1,0 @@ -# -# mailjam-mta.conf - Mailjam MTA client configuration file -# - -[server] -address = localhost -port = 9876 -uri = http://%(address)s:%(port)s -ssl = false - -[archive] -persistent = true -path = /usr/local/mailjam/archive-mta Index: nf/mailjam.conf =================================================================== --- conf/mailjam.conf (revision 33) +++ (revision ) @@ -1,30 +1,0 @@ -# -# mailjam.conf - Mailjam daemon configuration file -# - -[xmlrpc_server] -address = localhost -port = 9876 -ssl = false -ssl_key = /usr/local/etc/mailjam/ssl/mailjam.key -ssl_crt = /usr/local/etc/mailjam/ssl/mailjam.crt -logfile = /var/log/mailjam/xmlrpc_server.log -accesslog = /var/log/mailjam/access.log - -[storage] -backend = json -path = /usr/local/mailjam/storage -lists_db = %(path)s/mailings.%(backend)s -members_db = %(path)s/members.%(backend)s - -[archive] -enabled = true -backend = json -path = /usr/local/mailjam/archives - -[mailing_lists] -private = true - -[members] -auto_signup = false -allow_chpasswd = false Index: cs/html =================================================================== --- docs/html (revision 13) +++ (revision ) @@ -1,1 +1,0 @@ -src/_build/html Index: cs/src/Makefile =================================================================== --- docs/src/Makefile (revision 13) +++ (revision ) @@ -1,153 +1,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Postman.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Postman.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Postman" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Postman" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." Index: cs/src/_build/html/.buildinfo =================================================================== --- docs/src/_build/html/.buildinfo (revision 16) +++ (revision ) @@ -1,4 +1,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ceb77347f0c7a864ec9030a8b3dabfdc -tags: fbb0d17656682115ca4d033fb2f83ba1 Index: cs/src/_build/html/_sources/configuration.txt =================================================================== --- docs/src/_build/html/_sources/configuration.txt (revision 27) +++ (revision ) @@ -1,607 +1,0 @@ -Configuration -============= - -Mailjam has separate configuration files for the different apps (the daemon and -the variety of different clients available). Check below to read more about the -configuration file you need to modify depending on what you want to do. - -.. contents:: - -.. _configuration_daemon: - -Mailjam daemon configuration file - mailjam.conf ------------------------------------------------- - -All the configurations that can be applied to the :ref:`overview_mailjam_daemon` -are registered in the **mailjam.conf** file. That file contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam.conf file will be installed in different locations depending on - your setup. The usual locations are: - - - */etc/mailjam/mailjam.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam.conf* - In most BSD systems (like FreeBSD, - OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_daemon_xmlrpc: - -xmlrpc_server -+++++++++++++ - -This section contains the configuration parameters that modify the behaviour of -the daemon when serving content through XMLRPC [2]_. - -These are all the available parameters in this section: - -.. _configuration_daemon_xmlrpc_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon will be listening for XMLRPC requests. Use ``*`` -to listen an all available addresses, or any specific ``hostname`` or -``ip address`` value. - -.. _configuration_daemon_xmlrpc_port: - -port -**** - -Default: ``9876`` - -The port where the daemon will be listening por XMLRPC requests. - -.. _configuration_daemon_xmlrpc_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ support in the daemon. If ``false`` all the traffic -to/from the server will travel unencrypted. If ``true`` all the traffic will -travel encrypted. - -.. _configuration_daemon_xmlrpc_ssl_key: - -ssl_key -******* - -Default: ``/usr/local/etc/mailjam/ssl/mailjam.key`` - -Path to the ssl key used for encrypted SSL sessions. - -.. warning:: - - This parameter is not used right now, as ssl support hasn't been added yet) - -.. _configuration_daemon_xmlrpc_ssl_crt: - -ssl_crt -******* - -Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt`` - -Path to the ssl certificate used for encrypted SSL sessions. - -.. warning:: - - This parameter is not used right now, as ssl support hasn't been added yet) - -.. _configuration_daemon_xmlrpc_logfile: - -logfile -******* - -Default: ``/var/log/mailjam/xmlrpc_server.log`` - -Path to the file where log messages will be saved - -.. _configuration_daemon_storage: - -storage -+++++++ - -This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends. - -These are all the available parameters in this section: - -.. _configuration_daemon_storage_backend: - -backend -******* - -Default: ``json`` - -Sets the type of backend the daemon is going to use. Right now the only backend -available is ``json``. - -.. _configuration_daemon_xmlrpc_path: - -path -**** - -Default: ``/usr/local/mailjam/storage`` - -Path to the directory where the backend will save data. - -.. _configuration_daemon_storage_lists_db: - -lists_db -******** - -Default: ``/usr/local/mailjam/storage/mailings.json`` - -Path to the file where the identifiers of existing mailing lists will be saved. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - lists_db = %(path)s/mailings.%(backend)s - - That means that the parameter will inherit the values of the base path and - the extension of the file from the *storage.path* and *storage.backend* - settings. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. _configuration_daemon_xmlrpc_members_db: - -members_db -********** - -Default: ``/usr/local/mailjam/storage/members.json`` - -Path to the file where the identifiers of existing members will be saved. - -.. note:: - - The same notes as for the *lists_db* parameter apply to this configuration - parameter. - -.. _configuration_daemon_archive: - -archive -+++++++ - -This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends. - -These are all the available parameters in this section: - -.. _configuration_daemon_archive_enabled: - -enabled -******* - -Default: ``true`` - -Enables/disables the *archives* feature. When enabled, Mailjam saves copies of -email address into an *archive*, so they can be read later, through a web -interface. - -To disable that feature, set this to ``false``. - -.. warning:: - - This feature is not ready yet, so it doesn't matter if you set this to true - or false - -.. _configuration_daemon_archive_backend: - -backend -******* - -Default: ``json`` - -Sets the type of backend used to store messages into the archive. - -.. warning:: - - This feature is not ready yet. - -.. _configuration_daemon_archive_path: - -path -**** - -Default: ``/usr/local/mailjam/archives`` - -Path to the directory where the archives will be saved. - -.. warning:: - - This feature is not ready yet. - -.. _configuration_daemon_mailing_lists: - -mailing_lists -+++++++++++++ - -This section contains the configuration parameters that set the default -behaviour for mailing lists. - -.. warning:: - - This parameters are not currently used in mailjam, we are still working - on per-mailing-list configuration parameters. - -These are all the available parameters in this section: - -.. _configuration_daemon_mailing_lists_private: - -private -******* - -Default: ``true`` - -Sets if a given mailing list is *private* (only registered members can send -messages to the list) or not (anyone can send messages to the list). - -If ``false``, by default all new lists will not be private. - -.. _configuration_daemon_members: - -members -+++++++ - -This section contains the configuration parameters that set the default -behaviour for members. - -.. warning:: - - This parameters are not currently used in mailjam, we are still working - on per-member configuration parameters. - -These are all the available parameters in this section: - -.. _configuration_daemon_members_auto_signup: - -auto_signup -*********** - -Default: ``false`` - -Enables/disables auto-registration of members to mailing lists through a public -web application. If ``true``, users can register themselves into mailing lists -using a public web interface. If ``false``, only mailing lists administrators -will be able to add new members to the list. - -.. _configuration_daemon_members_allow_chpasswd: - -allow_chpasswd -************** - -Default: ``false`` - -Enables/disables the option to update passwords by the members themselves. - -If ``true``, members of a mailing list will be able to update their passwords -using a public web interface. If ``false``, only mailing lists administrators -will be able to reset those passwords. - -.. _configuration_mta_client: - -Mailjam MTA client configuration file - mailjam-mta.conf --------------------------------------------------------- - -This file contains all the parameters to configure the -:ref:`overview_mailjam_mta_client` properly. It contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam-mta.conf file will be installed in different locations - depending on your setup. The usual locations are: - - - */etc/mailjam/mailjam-mta.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam-mta.conf* - In most BSD systems (like - FreeBSD, OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_mta_client_server: - -server -++++++ - -This section contains the configuration parameters that tell the MTA client -where to connect when trying to interact with the -:ref:`overview_mailjam_daemon`. - -These are all the available parameters in this section: - -.. _configuration_mta_client_server_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to. - -.. _configuration_mta_client_server_port: - -port -**** - -Default: ``9876`` - -The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to. - -.. _configuration_mta_client_server_uri: - -uri -*** - -Default: http://localhost:9876 - -This is the URI [4]_ to where the client will connect to. It is constructed -based on the values of the :ref:`configuration_mta_client_server_address` -and :ref:`configuration_mta_client_server_port` parameters. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - uri = http://%(address)s:%(port)s - - That means that the parameter will inherit the values from the - :ref:`configuration_mta_client_server_address` - and :ref:`configuration_mta_client_server_port` parameters. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. warning:: - - You can replace this with any URI you would like, **this is the parameter - that is really used for establishing new connections** so be aware that if - you remove the references to the - :ref:`configuration_mta_client_server_address` and - :ref:`configuration_mta_client_server_port` parameters, the values you have - provided for those parameters will be ignored. - -.. _configuration_mta_client_server_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ connections to the daemon. If ``false`` all the -traffic to/from the server will travel unencrypted. If ``true`` all the traffic -will travel encrypted. - -.. warning:: - - In order to enable SSL support in the client, you have to be sure the - :ref:`overview_mailjam_daemon` supports SSL too (check the - :ref:`configuration_daemon_xmlrpc_ssl` parameter in the - :ref:`configuration_daemon_xmlrpc` section of the - :ref:`daemon configuration file `) - -.. _configuration_mta_client_archive: - -archive -+++++++ - -This section contains the configuration parameters that set where the files -generated by the client will be stored/saved. - -.. seealso:: - - For more information about the kind of files the client does generate, - take a look at the - :ref:`MTA client documentation `. - -These are all the available parameters in this section: - -.. _configurtion_mta_client_archive_persistent: - -persistent -********** - -Default: ``true`` - -Enables/disables the local archive for the client. If ``true``, the client -will save a copy of every email sent to the list in an internal archive, -that could be checked/queried later. If ``false``, the emails will not be -kept on disk after being processed. - -.. warning:: - - This feature is not ready yet. - - -.. _configuration_mta_client_archive_path: - -path -**** - -Default: ``/usr/local/mailjam/archive-mta`` - -Path to the directory where the archives will be saved. - -.. warning:: - - This feature is not ready yet. - - -.. _configuration_cli_client: - -Mailjam CLI client configuration file - mailjam-cli.conf --------------------------------------------------------- - -This file contains all the parameters to configure the -:ref:`overview_mailjam_cli_client` properly. It contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam-cli.conf file will be installed in different locations - depending on your setup. The usual locations are: - - - */etc/mailjam/mailjam-cli.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam-cli.conf* - In most BSD systems (like - FreeBSD, OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_cli_client_server: - -server -++++++ - -This section contains the configuration parameters that tell the cli client -where to connect when trying to interact with the -:ref:`overview_mailjam_daemon`. - -These are all the available parameters in this section: - -.. _configuration_cli_client_server_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to. - -.. _configuration_cli_client_server_port: - -port -**** - -Default: ``9876`` - -The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to. - -.. _configuration_cli_client_server_uri: - -uri -*** - -Default: http://localhost:9876 - -This is the URI [4]_ to where the client will connect to. It is constructed -based on the values of the :ref:`configuration_cli_client_server_address` -and :ref:`configuration_cli_client_server_port` parameters. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - uri = http://%(address)s:%(port)s - - That means that the parameter will inherit the values from the - :ref:`configuration_cli_client_server_address` - and :ref:`configuration_cli_client_server_port` parameters. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. warning:: - - You can replace this with any URI you would like, **this is the parameter - that is really used for establishing new connections** so be aware that if - you remove the references to the - :ref:`configuration_cli_client_server_address` and - :ref:`configuration_cli_client_server_port` parameters, the values you have - provided for those parameters will be ignored. - -.. _configuration_cli_client_server_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ connections to the daemon. If ``false`` all the -traffic to/from the server will travel unencrypted. If ``true`` all the traffic -will travel encrypted. - -.. warning:: - - In order to enable SSL support in the client, you have to be sure the - :ref:`overview_mailjam_daemon` supports SSL too (check the - :ref:`configuration_daemon_xmlrpc_ssl` parameter in the - :ref:`configuration_daemon_xmlrpc` section of the - :ref:`daemon configuration file `) - -.. _configuration_cli_client_history: - -history -+++++++ - -This section contains the configuration parameters that set the behaviour -of the client feature that allows it to save a history of commands provided -by the user. - -These are all the available parameters in this section: - -.. _configurtion_cli_client_archive_enabled: - -enabled -******* - -Default: ``true`` - -Enables/disables history support in the client. If ``true`` all commands -provided by an user will be saved to disk. If ``false`` nothing will be -written to disk. - -.. _configuration_cli_client_history_path: - -path -**** - -Default: ``~/.mailjam/cli/history`` - -Path to the file where the list of executed commands will be saved. - - -.. [1] http://en.wikipedia.org/wiki/INI_file -.. [2] http://en.wikipedia.org/wiki/XML-RPC -.. [3] http://en.wikipedia.org/wiki/Secure_Socket_Layer -.. [4] http://en.wikipedia.org/wiki/Uniform_resource_identifier Index: cs/src/_build/html/_sources/development.txt =================================================================== --- docs/src/_build/html/_sources/development.txt (revision 13) +++ (revision ) @@ -1,4 +1,0 @@ -Developers documentation -======================== - -.. contents:: Index: cs/src/_build/html/_sources/examples.txt =================================================================== --- docs/src/_build/html/_sources/examples.txt (revision 27) +++ (revision ) @@ -1,6 +1,0 @@ -Some examples -============= - -.. contents:: - -TBW Index: cs/src/_build/html/_sources/index.txt =================================================================== --- docs/src/_build/html/_sources/index.txt (revision 16) +++ (revision ) @@ -1,28 +1,0 @@ -Mailjam official documentation -============================== - -This is the official documentation for Mailjam_, a mailing list management -software written in Python_. - -Contents: - -.. toctree:: - :maxdepth: 2 - - overview - install - configuration - running - examples - development - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. _Mailjam: https://bitbucket.org/codigo23/mailjam -.. _Python: http://python.org Index: cs/src/_build/html/_sources/install.txt =================================================================== --- docs/src/_build/html/_sources/install.txt (revision 27) +++ (revision ) @@ -1,271 +1,0 @@ -Installation instructions -========================= - -Installing Mailjam is quite easy. If you have some experience installing -Python_ packages [1]_, you already know how to do it. Mailjam is a standard -Python_ package available on pypi_ [3]_ so just use your favourite tool -(pip_, easy_install_, etc) to intall it. - -Keep reading if you want to learn more about the different options/choices -you have when installing Mailjam. - -.. contents:: - -.. _install_dependencies: - -First, install dependencies ---------------------------- - -So far, the only dependency you will need in order to run mailjam is Python_ - -Mailjam has been tested with python *2.7.x*, but it should work with versions -*2.6.x* too. - -Please, refer to your operating system documentation to learn more about how -to install python. - -.. _install_mailjam: - -Second, install Mailjam ------------------------ - -You can install Mailjam using one of the available tools for installing Python_ -packages, or you can install it from sources. Keep reading to learn more about -it. - -.. _install_with_pip: - -Installing using pip -++++++++++++++++++++ - -You can install Mailjam using pip_:: - - pip install Mailjam - -.. note:: - - The previous command will install the latest release from pypi_. If you - would like to install the latest *bleeding edge* sources (unstable code), - you can do it using pip_ too:: - - pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -.. _install_with_easy_install: - -Installing using easy_install -+++++++++++++++++++++++++++++ - -You can install Mailjam using easy_install_:: - - easy_install Mailjam - -.. _install_inside_virtualenv: - -Installing inside a virtualenv -++++++++++++++++++++++++++++++ - -You can install Mailjam inside a virtualenv_. Just create a virtualenv:: - - virtualenv /path/to/your/env - -Then activate it:: - - source /path/to/your/env/bin/activate - -.. note:: - - If your shell is **csh**/**tcsh** remember you have to activate the - environment this way:: - - source /path/to/your/env/bin/activate.csh - -And, once the environment has been activated, use pip to install Mailjam:: - - env$ pip install Mailjam - -.. note:: - - Remember that you can install the latest *bleeding edge* version using - pip_ too:: - - env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -.. _install_from_sources: - -Installing from sources -+++++++++++++++++++++++ - -When installing from sources, you can download one of the official releases -or you can go with the *bleeding edge* and get a copy of the official source -code repository. - -.. _install_from_release: - -Releases -******** - -You can grab a copy of the latest release from pypi_: - -http://pypi.python.org/packages/source/m/mailjam/ - -After downloaded, you have to unpack the sources:: - - tar -zxvvf mailjam-0.1.0.tar.gz - -This will create a directory called *mailjam-0.1.0*, go inside that directory -and run:: - - python setup.py install - -.. warning:: - - If you want to install it *system-wide*, probably you will need *root* - privileges (check your OS documentation to learn more about how to get - *root* privileges - for example using sudo_) - -.. note:: - - This process will work inside a virtualenv_ too. - -.. _install_from_repository: - -From repository -*************** - -The source code of Mailjam is hosted in bitbucket_ [2]_. In order to grab -the latest sources you need Mercurial_. - -To get a copy of the sources, just *clone* the repository:: - - hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo - -Then, go inside the *mailjam-repo* directory and run:: - - python setup.py install - -.. warning:: - - If you want to install it *system-wide*, probably you will need *root* - privileges (check your OS documentation to learn more about how to get - *root* privileges - for example using sudo_) - -.. note:: - - This process will work inside a virtualenv_ too. - -.. _install_setting_up_mailjam: - -Setting up Mailjam ------------------- - -In order to setup Mailjam, you will have to create the needed -:doc:`configuration files `. Each component has its own -configuration file: - -- The :ref:`Mailjam daemon ` configuration file is - :ref:`mailjam.conf ` - -- The :ref:`Mailjam MTA client ` configuration - file is :ref:`mailjam-mta.conf ` - -- The :ref:`Mailjam CLI client ` configuration - file is :ref:`mailjam-cli.conf ` - -Refer to each configuration file documentation to learn more about the different -settings you can customize. - -Each component will search for its configuration file in a list of predefined -locations, but you can override that behaviour using the *-c* parameter when -starting the component. - -.. note:: - - Mailjam will search for the config files, in order, through the following - paths: - - 1. /etc/mailjam - - 2. /etc - - 3. /usr/local/etc/mailjam - - 4. /usr/local/etc - - 5. the *conf* directory within the sources (or the installed *egg* [4]_) - -For example, you can start the :ref:`overview_mailjam_daemon` passing -*/var/db/mailjam/mailjam.conf* as its configuration file:: - - mailjam-server -c /var/db/mailjam/mailjam.conf - -.. seealso:: - - :doc:`running` contains more information about how to run the different - components. - -If you have installed Mailjam using pip_, easy_install_ or even from sources, -the setup process should have taken care of the configuration files, adding -a copy of the default files included in the sources to the default -destination. - -.. warning:: - - The default destination will be different based on your operating system. - For example, in most linux servers it will copy the files to */etc/mailjam*, - while in BSD servers it will copy the files to */usr/local/etc/mailjam*. - -.. seealso:: - - :doc:`Configuration files, settings and formats documentation ` - - -.. _install_running_mailjam: - -Running Mailjam ---------------- - -In order to run a full Mailjam environment, you will have to start the different -components separately: - -1. :ref:`Start the daemon ` - -2. :ref:`Run the cli client and manage your mailing lists ` - -3. :ref:`Add as much MTA clients as you need to your mail server` - -The daemon will have to be running all the time (it is the component responsible -for providing information to the clients). You will need the CLI client to add, -edit or delete mailing lists and each MTA client will be responsible to handle -incoming emails for each mailing list. - -.. _install_running_tests: - -Running tests (developers only) -------------------------------- - -Just in case you were wondering, **yes**, Mailjam code has some tests you can -run to check everything is ok and that the software should run smoothly on your -server(s). - -To run the tests, simply get a copy of the sources from our public repository:: - - hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo - -then run the tests:: - - cd mailjam-repo && ./bin/run_tests - - -.. _Python: http://python.org -.. _pip: http://www.pip-installer.org/en/latest/index.html -.. _pypi: http://pypi.python.org/pypi -.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall -.. _virtualenv: http://www.virtualenv.org/en/latest/index.html -.. _bitbucket: https://bitbucket.org -.. _Mercurial: http://mercurial.selenic.com -.. _sudo: http://sudo.ws - -.. [1] http://docs.python.org/tutorial/modules.html#packages -.. [2] https://bitbucket.org/codigo23/mailjam -.. [3] http://pypi.python.org/pypi/mailjam -.. [4] http://svn.python.org/projects/sandbox/trunk/setuptools/doc/formats.txt Index: cs/src/_build/html/_sources/overview.txt =================================================================== --- docs/src/_build/html/_sources/overview.txt (revision 27) +++ (revision ) @@ -1,69 +1,0 @@ -Overview of mailjam's architecture -================================== - -.. contents:: - -Introduction ------------- - -Mailjam has been designed following a **multi-component structure**. There is -**a daemon** that manage the mailing lists and members information in a storage -backend and there are **different kinds of clients** (currently, three of them) -that **interact with the daemon using a XMLRPC link**. - -This is the scheme of the architecture: - -.. image:: /mailjam_architecture.png - :alt: Scheme of the architecture behind Mailjam - :class: open_fancybox - -This architecture works for small setups (everything running on a single server) -but it works for bigger/larger installations with up to N mail servers, running -each server its own :ref:`overview_mailjam_mta_client` (or multiple instances -of it) to connect to N :ref:`overview_mailjam_daemon` servers (managed locally -or remotely using up to N :ref:`overview_mailjam_cli_client` or -:ref:`overview_mailjam_web_client` instances). - -.. seealso:: - - :doc:`The examples documentation ` contains some useful examples - about different kinds of setups. - -.. _overview_mailjam_daemon: - -Mailjam daemon --------------- - -The daemon will perform all the operations regarding the management of the -mailing lists and members. The daemon will save information of a given -mailing list to the storage backend, and will read information of already -saved lists from there too. - -It listens for incoming XMLRPC requests on a given tcp port, allowing clients -to add/update/delete data from the backend. - -.. _overview_mailjam_mta_client: - -MTA client ----------- - -This client is attached to a given MTA, and is called but the MTA itself when -emails for a mailing lists are received. The client performs some checks on the -backend to tell the MTA what it has to do with the incoming emails. - -.. _overview_mailjam_cli_client: - -CLI client ----------- - -This is a shell-like interface that can be used to add mailing lists to a given -Mailjam server, edit such mailing lists information, add members, etc. - -.. _overview_mailjam_web_client: - -Web client ----------- - -This is a small *webapp* that can be used to perform the same management -operations you can achieve using the -:ref:`CLI client`. Index: cs/src/_build/html/_sources/running.txt =================================================================== --- docs/src/_build/html/_sources/running.txt (revision 27) +++ (revision ) @@ -1,354 +1,0 @@ -Running Mailjam -=============== - -In order to run Mailjam, you have to run the different components, depending on -what you want to do. Basically, you will need to run a server -(:ref:`overview_mailjam_daemon`) all the time, then you will need one -:ref:`overview_mailjam_mta_client` per mailing list. - -Ocasionally, you will need to add or delete a mailing list, or edit its -information, members list, etc. To do that, you will have to run a Mailjam -client (either the :ref:`CLI client ` or the -:ref:`Web client `). - -Keep reading if you want to learn more about the way you can start each -component, the different arguments/parameters you can provide on startup, etc. - -.. warning:: - - Remember that, before being able to run any component, you have to - :ref:`set up proper configuration files `. You - can learn more about Mailjam configuration files in the - :doc:`configuration files documentation `. - -.. contents:: - -.. _running_daemon: - -The daemon ----------- - -First component you should start is the :ref:`overview_mailjam_daemon`. It is -quite easy, just run this command from a shell/console:: - - mailjam-server - -The server process will read the :ref:`mailjam.conf ` -configuration file, will prepare everything and will start listening for XMLRPC -requests on *localhost:9876* - -.. warning:: - - *localhost:9876* is the default value provided by the default configuration - files. If you have modified that, it will be a different *address:port* - combination. - -.. warning:: - - If you didn't add a valid configuration file to one of the - :ref:`default paths `, the server will refuse to - start, giving you an error message. - -.. warning:: - - As of the current version of Mailjam, there are no pre-made init scripts that - can handle the start/stop/restart of the daemon, but those will be added in - one of the future releases. - -.. _running_daemon_parameters: - -Additional parameters -+++++++++++++++++++++ - -You can pass some parameters to *mailjam-server* to modify the behaviour of -the daemon or get more information. - -.. note:: - - Remember that the proper way to modify the behaviour of the daemon is - editing its configuration file, :ref:`mailjam.conf ` - -.. _running_daemon_help: - ---help -****** - -You can get some help by passing the *-h* or *--help* parameters:: - - mailjam-server -h - -:: - - mailjam-server --help - -.. _running_daemon_config: - ---config -******** - -You can set the path to the config file the server will load on startup, -passing the *-c* or *--config* parameters:: - - mailjam-server -c /home/mailjam/mailjam.conf - -:: - - mailjam-server --config /home/mailjam/mailjam.conf - -.. warning:: - - If the file does not exist, or if it is not a valid configuration file, - an error will be shown and the daemon will refuse to start. - -.. _running_daemon_version: - ---version -********* - -You can check the version of the mailjam server you are trying to run by -passing the *-v* or *--version* parameters:: - - mailjam-server -v - -:: - - mailjam-server --version - - -.. _running_cli_client: - -The CLI client --------------- - - - -.. _running_mta_client: - -The MTA client --------------- - -Once you have your :ref:`daemon running `, you have to add -as many :ref:`MTA clients ` as mailing lists you -want to manage to your mail server. - -.. _running_mta_client_quick: - -Quick configuration (you are a mail-servers-master) -+++++++++++++++++++++++++++++++++++++++++++++++++++ - -Edit your mail server aliases file [1]_ (probably */etc/aliases* or -*/etc/mail/aliases*) and add an entry like:: - - list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -" - -.. warning:: - - replace *list@mydomain.com* with the real address of your mailing list - -.. warning:: - - replace */usr/local/bin/mailjam-mta* with the real path to your mailjam-mta - installation - -Rebuild your *aliases* database:: - - newaliases - -.. warning:: - - Refer to your OS documentation to see how you can rebuild *aliases*. In most - unix-like systems it is done by the newaliases [2]_ command. - -.. _running_mta_client_explained: - -Explained configuration (you really want to know what's happening here) -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -When new messages arrive at your mail server for your mailing list address -(let's use the example address *list@mydomain.com*) one of the steps in the -process that checks the message, it's origin, destination, contents, etc is -the step where the mail server checks its internal *aliases* database, that is, -a list of *special* addresses that, instead of being *real* addresses, they are -related to some other addresses in some way. - -Most MTAs out there support one very *convenient* feature that is to *pipe* the -contents of the message (headers and body) to a given shell command. That means -that the all the received data will be sent to an external command for it to -process such data. - -**Here is where mailjam-mta comes in**. - -What you have to do is just tell your mail server that all messages with -destination *list@mydomain.com* (to keep using the same example address) will be -*piped* to mailman-mta. The Mailjam MTA client will then know what to do with -the message, performing some checks and re-sending it to the proper destinations -(the members/suscriptors of the given mailing list). - -So, first thing you have to find out is **where is your aliases file?**. - -In unix-like systems, like the different Linux distributions or the different -BSD flavours, that file is */etc/mail/aliases* or */etc/aliases* (usually one is -a simbolic link to the other). - -.. note:: - - Usually the aliases file contains some lines like:: - - MAILER-DAEMON: postmaster - postmaster: root - -Once you've found out where the file is, edit it and add this line to the bottom -of the file:: - - list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -" - -.. warning:: - - replace *list@mydomain.com* with the real address of your mailing list - -.. warning:: - - replace */usr/local/bin/mailjam-mta* with the real path to your mailjam-mta - installation - -There you are telling your mail server that any message coming **to** -*list@mydomain.com* will be passed to the mailjam-mta command, passing some -parameters to it: - -- **-a list@mydomain.com** tells mailjam-mta that the message is actually for - that mailing list. The MTA client will then use that value to check (against - the mailjam daemon) if it is a valid mailing list. - -- **-i -** tells mailjam-mta that the message will be *piped* directly. This is - important, as mailjam-mta can read the messages from files, but in this case - the mail server will *pipe* the data directly to mailjam-mta. - -Once you've added that line to your *aliases* file, you have to rebuild your -*aliases* database:: - - newaliases - -.. warning:: - - Refer to your OS documentation to see how you can rebuild *aliases*. In most - unix-like systems it is done by the newaliases [2]_ command. - -And you are done. Everything is ready now. - -.. _running_mta_client_parameters: - -Additional parameters -+++++++++++++++++++++ - -You can pass some parameters to *mailjam-mta* to modify the behaviour of -the client or get more information. - -.. note:: - - Remember that the proper way to modify the behaviour of the client is - editing its configuration file, - :ref:`mailjam-mta.conf ` - -.. _running_mta_client_help: - ---help -****** - -You can get some help by passing the *-h* or *--help* parameters:: - - mailjam-mta -h - -:: - - mailjam-mta --help - -.. _running_mta_client_config: - ---config -******** - -You can set the path to the config file the client will load on startup, -passing the *-c* or *--config* parameters:: - - mailjam-mta -c /home/mailjam/mailjam-mta.conf - -:: - - mailjam-mta --config /home/mailjam/mailjam-mta.conf - -.. warning:: - - If the file does not exist, or if it is not a valid configuration file, - an error will be shown and the client will refuse to start. - -.. _running_mta_client_version: - ---version -********* - -You can check the version of the mailjam client you are trying to run by -passing the *-v* or *--version* parameters:: - - mailjam-mta -v - -:: - - mailjam-mta --version - -.. _running_mta_client_address: - ---address (required) -******************** - -This parameter is required (you have to provide it with a value in order to -run the mailjam-mta). It sets the address of the mailing list managed by this -MTA client instance. - -The MTA client will use the provided value to do some checks on the daemon, -retrieving all the needed data to perform its tasks. - -You can pass a valid address using both the *-a* and *--address* parameters:: - - mailjam-mta -a list@mydomain.com - -:: - - mailjam-mta --address list@mydomain.com - -.. _running_mta_client_input: - ---input -******* - -This parameter tells mailjam-mta from where it has to read the message sent -to the mailing list. That could be a local file (to be readed from disk) or -a stream of data coming directly from the standard input (*stdin*). - -For a regular configuration/setup, the second option is preferred, as the mail -server will send the stream of data directly to mailjam-mta (as -:ref:`explained before `):: - - mailjam-mta -i - - -:: - - mailjam-mta --input - - -But perhaps some time you would like to send (again) a message you have on disk, -that could be done easily, passing the path to the file containing that message -to mailjam-mta:: - - mailjam-mta -i /home/backups/mail/that-important-mail.txt - -:: - - mailjam-mta -input /home/backups/mail/that-important-mail.txt - - -.. _running_web_client: - -The Web client --------------- - -.. [1] http://en.wikipedia.org/wiki/Email_alias -.. [2] http://www.freebsd.org/cgi/man.cgi?query=newaliases Index: cs/src/_build/html/_static/basic.css =================================================================== --- docs/src/_build/html/_static/basic.css (revision 13) +++ (revision ) @@ -1,540 +1,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar input[type="text"] { - width: 170px; -} - -div.sphinxsidebar input[type="submit"] { - width: 30px; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlighted { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: #060; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} Index: cs/src/_build/html/_static/default.css =================================================================== --- docs/src/_build/html/_static/default.css (revision 13) +++ (revision ) @@ -1,256 +1,0 @@ -/* - * default.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- default theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - - - -/* -- hyperlink styles ------------------------------------------------------ */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:visited { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - - - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th { - background-color: #ede; -} - -.warning tt { - background: #efc2c2; -} - -.note tt { - background: #d6d6d6; -} - -.viewcode-back { - font-family: sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} Index: cs/src/_build/html/_static/doctools.js =================================================================== --- docs/src/_build/html/_static/doctools.js (revision 13) +++ (revision ) @@ -1,247 +1,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -} - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * small function to check if an array contains - * a given item. - */ -jQuery.contains = function(arr, item) { - for (var i = 0; i < arr.length; i++) { - if (arr[i] == item) - return true; - } - return false; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span = document.createElement("span"); - span.className = className; - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this); - }); - } - } - return this.each(function() { - highlight(this); - }); -}; - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') - return string; - return (typeof translated == 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); Index: cs/src/_build/html/_static/jquery.js =================================================================== --- docs/src/_build/html/_static/jquery.js (revision 13) +++ (revision ) @@ -1,154 +1,0 @@ -/*! - * jQuery JavaScript Library v1.4.2 - * http://jquery.com/ - * - * Copyright 2010, John Resig - * Dual licensed under the MIT or GPL Version 2 licenses. - * http://jquery.org/license - * - * Includes Sizzle.js - * http://sizzlejs.com/ - * Copyright 2010, The Dojo Foundation - * Released under the MIT, BSD, and GPL Licenses. - * - * Date: Sat Feb 13 22:33:48 2010 -0500 - */ -(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, -Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& -(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, -a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== -"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, -function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; -var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, -parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= -false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= -s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, -applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; -else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, -a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== -w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, -cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= -c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); -a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, -function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); -k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), -C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= -e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& -f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; -if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", -e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, -"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, -d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, -e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); -t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| -g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, -CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, -g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, -text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, -setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= -h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== -"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, -h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& -q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; -if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); -(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: -function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= -{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== -"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", -d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? -a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== -1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= -c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, -wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, -prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, -this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); -return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, -""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); -return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", -""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= -c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? -c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= -function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= -Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, -"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= -a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= -a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== -"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, -serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), -function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, -global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& -e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? -"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== -false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= -false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", -c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| -d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); -g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== -1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== -"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; -if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== -"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| -c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; -this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= -this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, -e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; -a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); -c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, -d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- -f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": -"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in -e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); Index: cs/src/_build/html/_static/pygments.css =================================================================== --- docs/src/_build/html/_static/pygments.css (revision 13) +++ (revision ) @@ -1,62 +1,0 @@ -.highlight .hll { background-color: #ffffcc } -.highlight { background: #eeffcc; } -.highlight .c { color: #408090; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #007020; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #007020 } /* Comment.Preproc */ -.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #FF0000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #303030 } /* Generic.Output */ -.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0040D0 } /* Generic.Traceback */ -.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #007020 } /* Keyword.Pseudo */ -.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #902000 } /* Keyword.Type */ -.highlight .m { color: #208050 } /* Literal.Number */ -.highlight .s { color: #4070a0 } /* Literal.String */ -.highlight .na { color: #4070a0 } /* Name.Attribute */ -.highlight .nb { color: #007020 } /* Name.Builtin */ -.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.highlight .no { color: #60add5 } /* Name.Constant */ -.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #007020 } /* Name.Exception */ -.highlight .nf { color: #06287e } /* Name.Function */ -.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ -.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #bb60d5 } /* Name.Variable */ -.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mf { color: #208050 } /* Literal.Number.Float */ -.highlight .mh { color: #208050 } /* Literal.Number.Hex */ -.highlight .mi { color: #208050 } /* Literal.Number.Integer */ -.highlight .mo { color: #208050 } /* Literal.Number.Oct */ -.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ -.highlight .sc { color: #4070a0 } /* Literal.String.Char */ -.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ -.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ -.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.highlight .sx { color: #c65d09 } /* Literal.String.Other */ -.highlight .sr { color: #235388 } /* Literal.String.Regex */ -.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ -.highlight .ss { color: #517918 } /* Literal.String.Symbol */ -.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ -.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ -.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ -.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ Index: cs/src/_build/html/_static/searchtools.js =================================================================== --- docs/src/_build/html/_static/searchtools.js (revision 13) +++ (revision ) @@ -1,560 +1,0 @@ -/* - * searchtools.js_t - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilties for the full-text search. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words, hlwords is the list of normal, unstemmed - * words. the first one is used to find the occurance, the - * latter for highlighting it. - */ - -jQuery.makeSearchSummary = function(text, keywords, hlwords) { - var textLower = text.toLowerCase(); - var start = 0; - $.each(keywords, function() { - var i = textLower.indexOf(this.toLowerCase()); - if (i > -1) - start = i; - }); - start = Math.max(start - 120, 0); - var excerpt = ((start > 0) ? '...' : '') + - $.trim(text.substr(start, 240)) + - ((start + 240 - text.length) ? '...' : ''); - var rv = $('
').text(excerpt); - $.each(hlwords, function() { - rv = rv.highlightText(this, 'highlighted'); - }); - return rv; -} - - -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - - -/** - * Search Module - */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } - }, - - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, success: null, - dataType: "script", cache: true}); - }, - - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); - } - }, - - hasIndex : function() { - return this._index !== null; - }, - - deferQuery : function(query) { - this._queued_query = query; - }, - - stopPulse : function() { - this._pulse_status = 0; - }, - - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (var i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something - */ - performSearch : function(query) { - // create the required interface elements - this.out = $('#search-results'); - this.title = $('

' + _('Searching') + '

').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

').appendTo(this.out); - this.output = $('
    ').appendTo(this.out); - - $('#search-progress').text(_('Preparing search...')); - this.startPulse(); - - // index already loaded, the browser was quick! - if (this.hasIndex()) - this.query(query); - else - this.deferQuery(query); - }, - - query : function(query) { - var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; - - // Stem the searchterms and add them to the correct list - var stemmer = new Stemmer(); - var searchterms = []; - var excluded = []; - var hlterms = []; - var tmp = query.split(/\s+/); - var objectterms = []; - for (var i = 0; i < tmp.length; i++) { - if (tmp[i] != "") { - objectterms.push(tmp[i].toLowerCase()); - } - - if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || - tmp[i] == "") { - // skip this "word" - continue; - } - // stem the word - var word = stemmer.stemWord(tmp[i]).toLowerCase(); - // select the correct list - if (word[0] == '-') { - var toAppend = excluded; - word = word.substr(1); - } - else { - var toAppend = searchterms; - hlterms.push(tmp[i].toLowerCase()); - } - // only add if not already in the list - if (!$.contains(toAppend, word)) - toAppend.push(word); - }; - var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); - - // console.debug('SEARCH: searching for:'); - // console.info('required: ', searchterms); - // console.info('excluded: ', excluded); - - // prepare search - var filenames = this._index.filenames; - var titles = this._index.titles; - var terms = this._index.terms; - var fileMap = {}; - var files = null; - // different result priorities - var importantResults = []; - var objectResults = []; - var regularResults = []; - var unimportantResults = []; - $('#search-progress').empty(); - - // lookup as object - for (var i = 0; i < objectterms.length; i++) { - var others = [].concat(objectterms.slice(0,i), - objectterms.slice(i+1, objectterms.length)) - var results = this.performObjectSearch(objectterms[i], others); - // Assume first word is most likely to be the object, - // other words more likely to be in description. - // Therefore put matches for earlier words first. - // (Results are eventually used in reverse order). - objectResults = results[0].concat(objectResults); - importantResults = results[1].concat(importantResults); - unimportantResults = results[2].concat(unimportantResults); - } - - // perform the search on the required terms - for (var i = 0; i < searchterms.length; i++) { - var word = searchterms[i]; - // no match but word was a required one - if ((files = terms[word]) == null) - break; - if (files.length == undefined) { - files = [files]; - } - // create the mapping - for (var j = 0; j < files.length; j++) { - var file = files[j]; - if (file in fileMap) - fileMap[file].push(word); - else - fileMap[file] = [word]; - } - } - - // now check if the files don't contain excluded terms - for (var file in fileMap) { - var valid = true; - - // check if all requirements are matched - if (fileMap[file].length != searchterms.length) - continue; - - // ensure that none of the excluded terms is in the - // search result. - for (var i = 0; i < excluded.length; i++) { - if (terms[excluded[i]] == file || - $.contains(terms[excluded[i]] || [], file)) { - valid = false; - break; - } - } - - // if we have still a valid result we can add it - // to the result list - if (valid) - regularResults.push([filenames[file], titles[file], '', null]); - } - - // delete unused variables in order to not waste - // memory until list is retrieved completely - delete filenames, titles, terms; - - // now sort the regular results descending by title - regularResults.sort(function(a, b) { - var left = a[1].toLowerCase(); - var right = b[1].toLowerCase(); - return (left > right) ? -1 : ((left < right) ? 1 : 0); - }); - - // combine all results - var results = unimportantResults.concat(regularResults) - .concat(objectResults).concat(importantResults); - - // print the results - var resultCount = results.length; - function displayNextItem() { - // results left, load the summary and display it - if (results.length) { - var item = results.pop(); - var listItem = $('
  • '); - if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { - // dirhtml builder - var dirname = item[0] + '/'; - if (dirname.match(/\/index\/$/)) { - dirname = dirname.substring(0, dirname.length-6); - } else if (dirname == 'index/') { - dirname = ''; - } - listItem.append($('').attr('href', - DOCUMENTATION_OPTIONS.URL_ROOT + dirname + - highlightstring + item[2]).html(item[1])); - } else { - // normal html builders - listItem.append($('').attr('href', - item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + - highlightstring + item[2]).html(item[1])); - } - if (item[3]) { - listItem.append($(' (' + item[3] + ')')); - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { - $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + - item[0] + '.txt', function(data) { - if (data != '') { - listItem.append($.makeSearchSummary(data, searchterms, hlterms)); - Search.output.append(listItem); - } - listItem.slideDown(5, function() { - displayNextItem(); - }); - }, "text"); - } else { - // no source available, just display title - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } - } - // search finished, update title and status message - else { - Search.stopPulse(); - Search.title.text(_('Search Results')); - if (!resultCount) - Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); - else - Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); - Search.status.fadeIn(500); - } - } - displayNextItem(); - }, - - performObjectSearch : function(object, otherterms) { - var filenames = this._index.filenames; - var objects = this._index.objects; - var objnames = this._index.objnames; - var titles = this._index.titles; - - var importantResults = []; - var objectResults = []; - var unimportantResults = []; - - for (var prefix in objects) { - for (var name in objects[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - var match = objects[prefix][name]; - var objname = objnames[match[1]][2]; - var title = titles[match[0]]; - // If more than one term searched for, we require other words to be - // found in the name/title/description - if (otherterms.length > 0) { - var haystack = (prefix + ' ' + name + ' ' + - objname + ' ' + title).toLowerCase(); - var allfound = true; - for (var i = 0; i < otherterms.length; i++) { - if (haystack.indexOf(otherterms[i]) == -1) { - allfound = false; - break; - } - } - if (!allfound) { - continue; - } - } - var descr = objname + _(', in ') + title; - anchor = match[3]; - if (anchor == '') - anchor = fullname; - else if (anchor == '-') - anchor = objnames[match[1]][1] + '-' + fullname; - result = [filenames[match[0]], fullname, '#'+anchor, descr]; - switch (match[2]) { - case 1: objectResults.push(result); break; - case 0: importantResults.push(result); break; - case 2: unimportantResults.push(result); break; - } - } - } - } - - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - importantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - unimportantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - return [importantResults, objectResults, unimportantResults] - } -} - -$(document).ready(function() { - Search.init(); -}); Index: cs/src/_build/html/_static/sidebar.js =================================================================== --- docs/src/_build/html/_static/sidebar.js (revision 13) +++ (revision ) @@ -1,151 +1,0 @@ -/* - * sidebar.js - * ~~~~~~~~~~ - * - * This script makes the Sphinx sidebar collapsible. - * - * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds - * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton - * used to collapse and expand the sidebar. - * - * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden - * and the width of the sidebar and the margin-left of the document - * are decreased. When the sidebar is expanded the opposite happens. - * This script saves a per-browser/per-session cookie used to - * remember the position of the sidebar among the pages. - * Once the browser is closed the cookie is deleted and the position - * reset to the default (expanded). - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -$(function() { - // global elements used by the functions. - // the 'sidebarbutton' element is defined as global after its - // creation, in the add_sidebar_button function - var bodywrapper = $('.bodywrapper'); - var sidebar = $('.sphinxsidebar'); - var sidebarwrapper = $('.sphinxsidebarwrapper'); - - // for some reason, the document has no sidebar; do not run into errors - if (!sidebar.length) return; - - // original margin-left of the bodywrapper and width of the sidebar - // with the sidebar expanded - var bw_margin_expanded = bodywrapper.css('margin-left'); - var ssb_width_expanded = sidebar.width(); - - // margin-left of the bodywrapper and width of the sidebar - // with the sidebar collapsed - var bw_margin_collapsed = '.8em'; - var ssb_width_collapsed = '.8em'; - - // colors used by the current theme - var dark_color = $('.related').css('background-color'); - var light_color = $('.document').css('background-color'); - - function sidebar_is_collapsed() { - return sidebarwrapper.is(':not(:visible)'); - } - - function toggle_sidebar() { - if (sidebar_is_collapsed()) - expand_sidebar(); - else - collapse_sidebar(); - } - - function collapse_sidebar() { - sidebarwrapper.hide(); - sidebar.css('width', ssb_width_collapsed); - bodywrapper.css('margin-left', bw_margin_collapsed); - sidebarbutton.css({ - 'margin-left': '0', - 'height': bodywrapper.height() - }); - sidebarbutton.find('span').text('»'); - sidebarbutton.attr('title', _('Expand sidebar')); - document.cookie = 'sidebar=collapsed'; - } - - function expand_sidebar() { - bodywrapper.css('margin-left', bw_margin_expanded); - sidebar.css('width', ssb_width_expanded); - sidebarwrapper.show(); - sidebarbutton.css({ - 'margin-left': ssb_width_expanded-12, - 'height': bodywrapper.height() - }); - sidebarbutton.find('span').text('«'); - sidebarbutton.attr('title', _('Collapse sidebar')); - document.cookie = 'sidebar=expanded'; - } - - function add_sidebar_button() { - sidebarwrapper.css({ - 'float': 'left', - 'margin-right': '0', - 'width': ssb_width_expanded - 28 - }); - // create the button - sidebar.append( - '
    «
    ' - ); - var sidebarbutton = $('#sidebarbutton'); - light_color = sidebarbutton.css('background-color'); - // find the height of the viewport to center the '<<' in the page - var viewport_height; - if (window.innerHeight) - viewport_height = window.innerHeight; - else - viewport_height = $(window).height(); - sidebarbutton.find('span').css({ - 'display': 'block', - 'margin-top': (viewport_height - sidebar.position().top - 20) / 2 - }); - - sidebarbutton.click(toggle_sidebar); - sidebarbutton.attr('title', _('Collapse sidebar')); - sidebarbutton.css({ - 'color': '#FFFFFF', - 'border-left': '1px solid ' + dark_color, - 'font-size': '1.2em', - 'cursor': 'pointer', - 'height': bodywrapper.height(), - 'padding-top': '1px', - 'margin-left': ssb_width_expanded - 12 - }); - - sidebarbutton.hover( - function () { - $(this).css('background-color', dark_color); - }, - function () { - $(this).css('background-color', light_color); - } - ); - } - - function set_position_from_cookie() { - if (!document.cookie) - return; - var items = document.cookie.split(';'); - for(var k=0; k=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); -return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); -var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; -if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== -0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& -a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, -" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); -o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); Index: cs/src/_build/html/_static/websupport.js =================================================================== --- docs/src/_build/html/_static/websupport.js (revision 13) +++ (revision ) @@ -1,808 +1,0 @@ -/* - * websupport.js - * ~~~~~~~~~~~~~ - * - * sphinx.websupport utilties for all documentation. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -(function($) { - $.fn.autogrow = function() { - return this.each(function() { - var textarea = this; - - $.fn.autogrow.resize(textarea); - - $(textarea) - .focus(function() { - textarea.interval = setInterval(function() { - $.fn.autogrow.resize(textarea); - }, 500); - }) - .blur(function() { - clearInterval(textarea.interval); - }); - }); - }; - - $.fn.autogrow.resize = function(textarea) { - var lineHeight = parseInt($(textarea).css('line-height'), 10); - var lines = textarea.value.split('\n'); - var columns = textarea.cols; - var lineCount = 0; - $.each(lines, function() { - lineCount += Math.ceil(this.length / columns) || 1; - }); - var height = lineHeight * (lineCount + 1); - $(textarea).css('height', height); - }; -})(jQuery); - -(function($) { - var comp, by; - - function init() { - initEvents(); - initComparator(); - } - - function initEvents() { - $('a.comment-close').live("click", function(event) { - event.preventDefault(); - hide($(this).attr('id').substring(2)); - }); - $('a.vote').live("click", function(event) { - event.preventDefault(); - handleVote($(this)); - }); - $('a.reply').live("click", function(event) { - event.preventDefault(); - openReply($(this).attr('id').substring(2)); - }); - $('a.close-reply').live("click", function(event) { - event.preventDefault(); - closeReply($(this).attr('id').substring(2)); - }); - $('a.sort-option').live("click", function(event) { - event.preventDefault(); - handleReSort($(this)); - }); - $('a.show-proposal').live("click", function(event) { - event.preventDefault(); - showProposal($(this).attr('id').substring(2)); - }); - $('a.hide-proposal').live("click", function(event) { - event.preventDefault(); - hideProposal($(this).attr('id').substring(2)); - }); - $('a.show-propose-change').live("click", function(event) { - event.preventDefault(); - showProposeChange($(this).attr('id').substring(2)); - }); - $('a.hide-propose-change').live("click", function(event) { - event.preventDefault(); - hideProposeChange($(this).attr('id').substring(2)); - }); - $('a.accept-comment').live("click", function(event) { - event.preventDefault(); - acceptComment($(this).attr('id').substring(2)); - }); - $('a.delete-comment').live("click", function(event) { - event.preventDefault(); - deleteComment($(this).attr('id').substring(2)); - }); - $('a.comment-markup').live("click", function(event) { - event.preventDefault(); - toggleCommentMarkupBox($(this).attr('id').substring(2)); - }); - } - - /** - * Set comp, which is a comparator function used for sorting and - * inserting comments into the list. - */ - function setComparator() { - // If the first three letters are "asc", sort in ascending order - // and remove the prefix. - if (by.substring(0,3) == 'asc') { - var i = by.substring(3); - comp = function(a, b) { return a[i] - b[i]; }; - } else { - // Otherwise sort in descending order. - comp = function(a, b) { return b[by] - a[by]; }; - } - - // Reset link styles and format the selected sort option. - $('a.sel').attr('href', '#').removeClass('sel'); - $('a.by' + by).removeAttr('href').addClass('sel'); - } - - /** - * Create a comp function. If the user has preferences stored in - * the sortBy cookie, use those, otherwise use the default. - */ - function initComparator() { - by = 'rating'; // Default to sort by rating. - // If the sortBy cookie is set, use that instead. - if (document.cookie.length > 0) { - var start = document.cookie.indexOf('sortBy='); - if (start != -1) { - start = start + 7; - var end = document.cookie.indexOf(";", start); - if (end == -1) { - end = document.cookie.length; - by = unescape(document.cookie.substring(start, end)); - } - } - } - setComparator(); - } - - /** - * Show a comment div. - */ - function show(id) { - $('#ao' + id).hide(); - $('#ah' + id).show(); - var context = $.extend({id: id}, opts); - var popup = $(renderTemplate(popupTemplate, context)).hide(); - popup.find('textarea[name="proposal"]').hide(); - popup.find('a.by' + by).addClass('sel'); - var form = popup.find('#cf' + id); - form.submit(function(event) { - event.preventDefault(); - addComment(form); - }); - $('#s' + id).after(popup); - popup.slideDown('fast', function() { - getComments(id); - }); - } - - /** - * Hide a comment div. - */ - function hide(id) { - $('#ah' + id).hide(); - $('#ao' + id).show(); - var div = $('#sc' + id); - div.slideUp('fast', function() { - div.remove(); - }); - } - - /** - * Perform an ajax request to get comments for a node - * and insert the comments into the comments tree. - */ - function getComments(id) { - $.ajax({ - type: 'GET', - url: opts.getCommentsURL, - data: {node: id}, - success: function(data, textStatus, request) { - var ul = $('#cl' + id); - var speed = 100; - $('#cf' + id) - .find('textarea[name="proposal"]') - .data('source', data.source); - - if (data.comments.length === 0) { - ul.html('
  • No comments yet.
    • '); - ul.data('empty', true); - } else { - // If there are comments, sort them and put them in the list. - var comments = sortComments(data.comments); - speed = data.comments.length * 100; - appendComments(comments, ul); - ul.data('empty', false); - } - $('#cn' + id).slideUp(speed + 200); - ul.slideDown(speed); - }, - error: function(request, textStatus, error) { - showError('Oops, there was a problem retrieving the comments.'); - }, - dataType: 'json' - }); - } - - /** - * Add a comment via ajax and insert the comment into the comment tree. - */ - function addComment(form) { - var node_id = form.find('input[name="node"]').val(); - var parent_id = form.find('input[name="parent"]').val(); - var text = form.find('textarea[name="comment"]').val(); - var proposal = form.find('textarea[name="proposal"]').val(); - - if (text == '') { - showError('Please enter a comment.'); - return; - } - - // Disable the form that is being submitted. - form.find('textarea,input').attr('disabled', 'disabled'); - - // Send the comment to the server. - $.ajax({ - type: "POST", - url: opts.addCommentURL, - dataType: 'json', - data: { - node: node_id, - parent: parent_id, - text: text, - proposal: proposal - }, - success: function(data, textStatus, error) { - // Reset the form. - if (node_id) { - hideProposeChange(node_id); - } - form.find('textarea') - .val('') - .add(form.find('input')) - .removeAttr('disabled'); - var ul = $('#cl' + (node_id || parent_id)); - if (ul.data('empty')) { - $(ul).empty(); - ul.data('empty', false); - } - insertComment(data.comment); - var ao = $('#ao' + node_id); - ao.find('img').attr({'src': opts.commentBrightImage}); - if (node_id) { - // if this was a "root" comment, remove the commenting box - // (the user can get it back by reopening the comment popup) - $('#ca' + node_id).slideUp(); - } - }, - error: function(request, textStatus, error) { - form.find('textarea,input').removeAttr('disabled'); - showError('Oops, there was a problem adding the comment.'); - } - }); - } - - /** - * Recursively append comments to the main comment list and children - * lists, creating the comment tree. - */ - function appendComments(comments, ul) { - $.each(comments, function() { - var div = createCommentDiv(this); - ul.append($(document.createElement('li')).html(div)); - appendComments(this.children, div.find('ul.comment-children')); - // To avoid stagnating data, don't store the comments children in data. - this.children = null; - div.data('comment', this); - }); - } - - /** - * After adding a new comment, it must be inserted in the correct - * location in the comment tree. - */ - function insertComment(comment) { - var div = createCommentDiv(comment); - - // To avoid stagnating data, don't store the comments children in data. - comment.children = null; - div.data('comment', comment); - - var ul = $('#cl' + (comment.node || comment.parent)); - var siblings = getChildren(ul); - - var li = $(document.createElement('li')); - li.hide(); - - // Determine where in the parents children list to insert this comment. - for(i=0; i < siblings.length; i++) { - if (comp(comment, siblings[i]) <= 0) { - $('#cd' + siblings[i].id) - .parent() - .before(li.html(div)); - li.slideDown('fast'); - return; - } - } - - // If we get here, this comment rates lower than all the others, - // or it is the only comment in the list. - ul.append(li.html(div)); - li.slideDown('fast'); - } - - function acceptComment(id) { - $.ajax({ - type: 'POST', - url: opts.acceptCommentURL, - data: {id: id}, - success: function(data, textStatus, request) { - $('#cm' + id).fadeOut('fast'); - $('#cd' + id).removeClass('moderate'); - }, - error: function(request, textStatus, error) { - showError('Oops, there was a problem accepting the comment.'); - } - }); - } - - function deleteComment(id) { - $.ajax({ - type: 'POST', - url: opts.deleteCommentURL, - data: {id: id}, - success: function(data, textStatus, request) { - var div = $('#cd' + id); - if (data == 'delete') { - // Moderator mode: remove the comment and all children immediately - div.slideUp('fast', function() { - div.remove(); - }); - return; - } - // User mode: only mark the comment as deleted - div - .find('span.user-id:first') - .text('[deleted]').end() - .find('div.comment-text:first') - .text('[deleted]').end() - .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + - ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) - .remove(); - var comment = div.data('comment'); - comment.username = '[deleted]'; - comment.text = '[deleted]'; - div.data('comment', comment); - }, - error: function(request, textStatus, error) { - showError('Oops, there was a problem deleting the comment.'); - } - }); - } - - function showProposal(id) { - $('#sp' + id).hide(); - $('#hp' + id).show(); - $('#pr' + id).slideDown('fast'); - } - - function hideProposal(id) { - $('#hp' + id).hide(); - $('#sp' + id).show(); - $('#pr' + id).slideUp('fast'); - } - - function showProposeChange(id) { - $('#pc' + id).hide(); - $('#hc' + id).show(); - var textarea = $('#pt' + id); - textarea.val(textarea.data('source')); - $.fn.autogrow.resize(textarea[0]); - textarea.slideDown('fast'); - } - - function hideProposeChange(id) { - $('#hc' + id).hide(); - $('#pc' + id).show(); - var textarea = $('#pt' + id); - textarea.val('').removeAttr('disabled'); - textarea.slideUp('fast'); - } - - function toggleCommentMarkupBox(id) { - $('#mb' + id).toggle(); - } - - /** Handle when the user clicks on a sort by link. */ - function handleReSort(link) { - var classes = link.attr('class').split(/\s+/); - for (var i=0; iThank you! Your comment will show up ' - + 'once it is has been approved by a moderator.'); - } - // Prettify the comment rating. - comment.pretty_rating = comment.rating + ' point' + - (comment.rating == 1 ? '' : 's'); - // Make a class (for displaying not yet moderated comments differently) - comment.css_class = comment.displayed ? '' : ' moderate'; - // Create a div for this comment. - var context = $.extend({}, opts, comment); - var div = $(renderTemplate(commentTemplate, context)); - - // If the user has voted on this comment, highlight the correct arrow. - if (comment.vote) { - var direction = (comment.vote == 1) ? 'u' : 'd'; - div.find('#' + direction + 'v' + comment.id).hide(); - div.find('#' + direction + 'u' + comment.id).show(); - } - - if (opts.moderator || comment.text != '[deleted]') { - div.find('a.reply').show(); - if (comment.proposal_diff) - div.find('#sp' + comment.id).show(); - if (opts.moderator && !comment.displayed) - div.find('#cm' + comment.id).show(); - if (opts.moderator || (opts.username == comment.username)) - div.find('#dc' + comment.id).show(); - } - return div; - } - - /** - * A simple template renderer. Placeholders such as <%id%> are replaced - * by context['id'] with items being escaped. Placeholders such as <#id#> - * are not escaped. - */ - function renderTemplate(template, context) { - var esc = $(document.createElement('div')); - - function handle(ph, escape) { - var cur = context; - $.each(ph.split('.'), function() { - cur = cur[this]; - }); - return escape ? esc.text(cur || "").html() : cur; - } - - return template.replace(/<([%#])([\w\.]*)\1>/g, function() { - return handle(arguments[2], arguments[1] == '%' ? true : false); - }); - } - - /** Flash an error message briefly. */ - function showError(message) { - $(document.createElement('div')).attr({'class': 'popup-error'}) - .append($(document.createElement('div')) - .attr({'class': 'error-message'}).text(message)) - .appendTo('body') - .fadeIn("slow") - .delay(2000) - .fadeOut("slow"); - } - - /** Add a link the user uses to open the comments popup. */ - $.fn.comment = function() { - return this.each(function() { - var id = $(this).attr('id').substring(1); - var count = COMMENT_METADATA[id]; - var title = count + ' comment' + (count == 1 ? '' : 's'); - var image = count > 0 ? opts.commentBrightImage : opts.commentImage; - var addcls = count == 0 ? ' nocomment' : ''; - $(this) - .append( - $(document.createElement('a')).attr({ - href: '#', - 'class': 'sphinx-comment-open' + addcls, - id: 'ao' + id - }) - .append($(document.createElement('img')).attr({ - src: image, - alt: 'comment', - title: title - })) - .click(function(event) { - event.preventDefault(); - show($(this).attr('id').substring(2)); - }) - ) - .append( - $(document.createElement('a')).attr({ - href: '#', - 'class': 'sphinx-comment-close hidden', - id: 'ah' + id - }) - .append($(document.createElement('img')).attr({ - src: opts.closeCommentImage, - alt: 'close', - title: 'close' - })) - .click(function(event) { - event.preventDefault(); - hide($(this).attr('id').substring(2)); - }) - ); - }); - }; - - var opts = { - processVoteURL: '/_process_vote', - addCommentURL: '/_add_comment', - getCommentsURL: '/_get_comments', - acceptCommentURL: '/_accept_comment', - deleteCommentURL: '/_delete_comment', - commentImage: '/static/_static/comment.png', - closeCommentImage: '/static/_static/comment-close.png', - loadingImage: '/static/_static/ajax-loader.gif', - commentBrightImage: '/static/_static/comment-bright.png', - upArrow: '/static/_static/up.png', - downArrow: '/static/_static/down.png', - upArrowPressed: '/static/_static/up-pressed.png', - downArrowPressed: '/static/_static/down-pressed.png', - voting: false, - moderator: false - }; - - if (typeof COMMENT_OPTIONS != "undefined") { - opts = jQuery.extend(opts, COMMENT_OPTIONS); - } - - var popupTemplate = '\ -
    \ -

    \ - Sort by:\ - best rated\ - newest\ - oldest\ -

    \ -
    Comments
    \ -
    \ - loading comments...
    \ -
      \ -
      \ -

      Add a comment\ - (markup):

      \ -
      \ - reStructured text markup: *emph*, **strong**, \ - ``code``, \ - code blocks: :: and an indented block after blank line
      \ -
      \ - \ -

      \ - \ - Propose a change ▹\ - \ - \ - Propose a change ▿\ - \ -

      \ - \ - \ - \ - \ -
      \ -
      \ -
      '; - - var commentTemplate = '\ -
      \ -
      \ -
      \ - \ - \ - \ - \ - \ - \ -
      \ -
      \ - \ - \ - \ - \ - \ - \ -
      \ -
      \ -
      \ -

      \ - <%username%>\ - <%pretty_rating%>\ - <%time.delta%>\ -

      \ -
      <#text#>
      \ -

      \ - \ - reply ▿\ - proposal ▹\ - proposal ▿\ - \ - \ -

      \ - 
      \
-<#proposal_diff#>\
-
      \ -
        \ -
        \ -
        \ -
        \ - '; - - var replyTemplate = '\ -
      • \ -
        \ -
        \ - \ - \ - \ - \ - \ -
        \ -
        \ -
        • '; - - $(document).ready(function() { - init(); - }); -})(jQuery); - -$(document).ready(function() { - // add comment anchors for all paragraphs that are commentable - $('.sphinx-has-comment').comment(); - - // highlight search words in search results - $("div.context").each(function() { - var params = $.getQueryParameters(); - var terms = (params.q) ? params.q[0].split(/\s+/) : []; - var result = $(this); - $.each(terms, function() { - result.highlightText(this.toLowerCase(), 'highlighted'); - }); - }); - - // directly open comment window if requested - var anchor = document.location.hash; - if (anchor.substring(0, 9) == '#comment-') { - $('#ao' + anchor.substring(9)).click(); - document.location.hash = '#s' + anchor.substring(9); - } -}); Index: cs/src/_build/html/configuration.html =================================================================== --- docs/src/_build/html/configuration.html (revision 27) +++ (revision ) @@ -1,701 +1,0 @@ - - - - - - - - - - Configuration — Mailjam 0.1.0 documentation - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Configuration¶

        -

        Mailjam has separate configuration files for the different apps (the daemon and -the variety of different clients available). Check below to read more about the -configuration file you need to modify depending on what you want to do.

        - -
        -

        Mailjam daemon configuration file - mailjam.conf¶

        -

        All the configurations that can be applied to the Mailjam daemon -are registered in the mailjam.conf file. That file contains ini-style [1] -configuration parameters, separated in different categories.

        -
        -

        Note

        -

        The mailjam.conf file will be installed in different locations depending on -your setup. The usual locations are:

        -
          -
        • /etc/mailjam/mailjam.conf - In most Linux systems (like archlinux, -gentoo, fedora, debian, ubuntu, etc)
          • -
        • /usr/local/etc/mailjam/mailjam.conf - In most BSD systems (like FreeBSD, -OpenBSD, NetBSD, etc)
          • -
        -

        There is a copy of the configuration file in the conf/ directory, within -the sources.

        -
        -
        -

        xmlrpc_server¶

        -

        This section contains the configuration parameters that modify the behaviour of -the daemon when serving content through XMLRPC [2].

        -

        These are all the available parameters in this section:

        -
        -

        address¶

        -

        Default: localhost

        -

        The address where the daemon will be listening for XMLRPC requests. Use * -to listen an all available addresses, or any specific hostname or -ip address value.

        -
        -
        -

        port¶

        -

        Default: 9876

        -

        The port where the daemon will be listening por XMLRPC requests.

        -
        -
        -

        ssl¶

        -

        Default: false (because ssl support hasn’t been added yet)

        -

        Enables/disables SSL [3] support in the daemon. If false all the traffic -to/from the server will travel unencrypted. If true all the traffic will -travel encrypted.

        -
        -
        -

        ssl_key¶

        -

        Default: /usr/local/etc/mailjam/ssl/mailjam.key

        -

        Path to the ssl key used for encrypted SSL sessions.

        -
        -

        Warning

        -

        This parameter is not used right now, as ssl support hasn’t been added yet)

        -
        -
        -
        -

        ssl_crt¶

        -

        Default: /usr/local/etc/mailjam/ssl/mailjam.crt

        -

        Path to the ssl certificate used for encrypted SSL sessions.

        -
        -

        Warning

        -

        This parameter is not used right now, as ssl support hasn’t been added yet)

        -
        -
        -
        -

        logfile¶

        -

        Default: /var/log/mailjam/xmlrpc_server.log

        -

        Path to the file where log messages will be saved

        -
        -
        -
        -

        storage¶

        -

        This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends.

        -

        These are all the available parameters in this section:

        -
        -

        backend¶

        -

        Default: json

        -

        Sets the type of backend the daemon is going to use. Right now the only backend -available is json.

        -
        -
        -

        path¶

        -

        Default: /usr/local/mailjam/storage

        -

        Path to the directory where the backend will save data.

        -
        -
        -

        lists_db¶

        -

        Default: /usr/local/mailjam/storage/mailings.json

        -

        Path to the file where the identifiers of existing mailing lists will be saved.

        -
        -

        Note

        -

        The default configuration file contains a dynamic setting for this -parameter:

        -
        lists_db = %(path)s/mailings.%(backend)s
        -
        -

        That means that the parameter will inherit the values of the base path and -the extension of the file from the storage.path and storage.backend -settings.

        -
        -
        -

        See also

        -

        More information about this (and other tricks) here:

        -

        http://docs.python.org/library/configparser.html

        -

        http://www.doughellmann.com/PyMOTW/ConfigParser

        -
        -
        -
        -

        members_db¶

        -

        Default: /usr/local/mailjam/storage/members.json

        -

        Path to the file where the identifiers of existing members will be saved.

        -
        -

        Note

        -

        The same notes as for the lists_db parameter apply to this configuration -parameter.

        -
        -
        -
        -
        -

        archive¶

        -

        This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends.

        -

        These are all the available parameters in this section:

        -
        -

        enabled¶

        -

        Default: true

        -

        Enables/disables the archives feature. When enabled, Mailjam saves copies of -email address into an archive, so they can be read later, through a web -interface.

        -

        To disable that feature, set this to false.

        -
        -

        Warning

        -

        This feature is not ready yet, so it doesn’t matter if you set this to true -or false

        -
        -
        -
        -

        backend¶

        -

        Default: json

        -

        Sets the type of backend used to store messages into the archive.

        -
        -

        Warning

        -

        This feature is not ready yet.

        -
        -
        -
        -

        path¶

        -

        Default: /usr/local/mailjam/archives

        -

        Path to the directory where the archives will be saved.

        -
        -

        Warning

        -

        This feature is not ready yet.

        -
        -
        -
        -
        -

        mailing_lists¶

        -

        This section contains the configuration parameters that set the default -behaviour for mailing lists.

        -
        -

        Warning

        -

        This parameters are not currently used in mailjam, we are still working -on per-mailing-list configuration parameters.

        -
        -

        These are all the available parameters in this section:

        -
        -

        private¶

        -

        Default: true

        -

        Sets if a given mailing list is private (only registered members can send -messages to the list) or not (anyone can send messages to the list).

        -

        If false, by default all new lists will not be private.

        -
        -
        -
        -

        members¶

        -

        This section contains the configuration parameters that set the default -behaviour for members.

        -
        -

        Warning

        -

        This parameters are not currently used in mailjam, we are still working -on per-member configuration parameters.

        -
        -

        These are all the available parameters in this section:

        -
        -

        auto_signup¶

        -

        Default: false

        -

        Enables/disables auto-registration of members to mailing lists through a public -web application. If true, users can register themselves into mailing lists -using a public web interface. If false, only mailing lists administrators -will be able to add new members to the list.

        -
        -
        -

        allow_chpasswd¶

        -

        Default: false

        -

        Enables/disables the option to update passwords by the members themselves.

        -

        If true, members of a mailing list will be able to update their passwords -using a public web interface. If false, only mailing lists administrators -will be able to reset those passwords.

        -
        -
        -
        -
        -

        Mailjam MTA client configuration file - mailjam-mta.conf¶

        -

        This file contains all the parameters to configure the -MTA client properly. It contains ini-style [1] -configuration parameters, separated in different categories.

        -
        -

        Note

        -

        The mailjam-mta.conf file will be installed in different locations -depending on your setup. The usual locations are:

        -
          -
        • /etc/mailjam/mailjam-mta.conf - In most Linux systems (like archlinux, -gentoo, fedora, debian, ubuntu, etc)
          • -
        • /usr/local/etc/mailjam/mailjam-mta.conf - In most BSD systems (like -FreeBSD, OpenBSD, NetBSD, etc)
          • -
        -

        There is a copy of the configuration file in the conf/ directory, within -the sources.

        -
        -
        -

        server¶

        -

        This section contains the configuration parameters that tell the MTA client -where to connect when trying to interact with the -Mailjam daemon.

        -

        These are all the available parameters in this section:

        -
        -

        address¶

        -

        Default: localhost

        -

        The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to.

        -
        -
        -

        port¶

        -

        Default: 9876

        -

        The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to.

        -
        -
        -

        uri¶

        -

        Default: http://localhost:9876

        -

        This is the URI [4] to where the client will connect to. It is constructed -based on the values of the address -and port parameters.

        -
        -

        Note

        -

        The default configuration file contains a dynamic setting for this -parameter:

        -
        uri = http://%(address)s:%(port)s
        -
        -

        That means that the parameter will inherit the values from the -address -and port parameters.

        -
        -
        -

        See also

        -

        More information about this (and other tricks) here:

        -

        http://docs.python.org/library/configparser.html

        -

        http://www.doughellmann.com/PyMOTW/ConfigParser

        -
        -
        -

        Warning

        -

        You can replace this with any URI you would like, this is the parameter -that is really used for establishing new connections so be aware that if -you remove the references to the -address and -port parameters, the values you have -provided for those parameters will be ignored.

        -
        -
        -
        -

        ssl¶

        -

        Default: false (because ssl support hasn’t been added yet)

        -

        Enables/disables SSL [3] connections to the daemon. If false all the -traffic to/from the server will travel unencrypted. If true all the traffic -will travel encrypted.

        -
        -

        Warning

        -

        In order to enable SSL support in the client, you have to be sure the -Mailjam daemon supports SSL too (check the -ssl parameter in the -xmlrpc_server section of the -daemon configuration file)

        -
        -
        -
        -
        -

        archive¶

        -

        This section contains the configuration parameters that set where the files -generated by the client will be stored/saved.

        -
        -

        See also

        -

        For more information about the kind of files the client does generate, -take a look at the -MTA client documentation.

        -
        -

        These are all the available parameters in this section:

        -
        -

        persistent¶

        -

        Default: true

        -

        Enables/disables the local archive for the client. If true, the client -will save a copy of every email sent to the list in an internal archive, -that could be checked/queried later. If false, the emails will not be -kept on disk after being processed.

        -
        -

        Warning

        -

        This feature is not ready yet.

        -
        -
        -
        -

        path¶

        -

        Default: /usr/local/mailjam/archive-mta

        -

        Path to the directory where the archives will be saved.

        -
        -

        Warning

        -

        This feature is not ready yet.

        -
        -
        -
        -
        -
        -

        Mailjam CLI client configuration file - mailjam-cli.conf¶

        -

        This file contains all the parameters to configure the -CLI client properly. It contains ini-style [1] -configuration parameters, separated in different categories.

        -
        -

        Note

        -

        The mailjam-cli.conf file will be installed in different locations -depending on your setup. The usual locations are:

        -
          -
        • /etc/mailjam/mailjam-cli.conf - In most Linux systems (like archlinux, -gentoo, fedora, debian, ubuntu, etc)
          • -
        • /usr/local/etc/mailjam/mailjam-cli.conf - In most BSD systems (like -FreeBSD, OpenBSD, NetBSD, etc)
          • -
        -

        There is a copy of the configuration file in the conf/ directory, within -the sources.

        -
        -
        -

        server¶

        -

        This section contains the configuration parameters that tell the cli client -where to connect when trying to interact with the -Mailjam daemon.

        -

        These are all the available parameters in this section:

        -
        -

        address¶

        -

        Default: localhost

        -

        The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to.

        -
        -
        -

        port¶

        -

        Default: 9876

        -

        The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to.

        -
        -
        -

        uri¶

        -

        Default: http://localhost:9876

        -

        This is the URI [4] to where the client will connect to. It is constructed -based on the values of the address -and port parameters.

        -
        -

        Note

        -

        The default configuration file contains a dynamic setting for this -parameter:

        -
        uri = http://%(address)s:%(port)s
        -
        -

        That means that the parameter will inherit the values from the -address -and port parameters.

        -
        -
        -

        See also

        -

        More information about this (and other tricks) here:

        -

        http://docs.python.org/library/configparser.html

        -

        http://www.doughellmann.com/PyMOTW/ConfigParser

        -
        -
        -

        Warning

        -

        You can replace this with any URI you would like, this is the parameter -that is really used for establishing new connections so be aware that if -you remove the references to the -address and -port parameters, the values you have -provided for those parameters will be ignored.

        -
        -
        -
        -

        ssl¶

        -

        Default: false (because ssl support hasn’t been added yet)

        -

        Enables/disables SSL [3] connections to the daemon. If false all the -traffic to/from the server will travel unencrypted. If true all the traffic -will travel encrypted.

        -
        -

        Warning

        -

        In order to enable SSL support in the client, you have to be sure the -Mailjam daemon supports SSL too (check the -ssl parameter in the -xmlrpc_server section of the -daemon configuration file)

        -
        -
        -
        -
        -

        history¶

        -

        This section contains the configuration parameters that set the behaviour -of the client feature that allows it to save a history of commands provided -by the user.

        -

        These are all the available parameters in this section:

        -
        -

        enabled¶

        -

        Default: true

        -

        Enables/disables history support in the client. If true all commands -provided by an user will be saved to disk. If false nothing will be -written to disk.

        -
        -
        -

        path¶

        -

        Default: ~/.mailjam/cli/history

        -

        Path to the file where the list of executed commands will be saved.

        - - - - - -
        [1](1, 2, 3) http://en.wikipedia.org/wiki/INI_file
        - - - - - -
        [2]http://en.wikipedia.org/wiki/XML-RPC
        - - - - - -
        [3](1, 2, 3) http://en.wikipedia.org/wiki/Secure_Socket_Layer
        - - - - - -
        [4](1, 2) http://en.wikipedia.org/wiki/Uniform_resource_identifier
        -
        -
        -
        -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Previous topic

        -

        Installation instructions

        -

        Next topic

        -

        Running Mailjam

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/development.html =================================================================== --- docs/src/_build/html/development.html (revision 16) +++ (revision ) @@ -1,108 +1,0 @@ - - - - - - - - - - Developers documentation — Mailjam 0.1.0 documentation - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - - - - -
        -
        -
        -
        -
        -

        Previous topic

        -

        Some examples

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/examples.html =================================================================== --- docs/src/_build/html/examples.html (revision 27) +++ (revision ) @@ -1,119 +1,0 @@ - - - - - - - - - - Some examples — Mailjam 0.1.0 documentation - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Some examples¶

        -
        -

        Contents

        - -
        -

        TBW

        -
        - - -
        -
        -
        -
        -
        -

        Previous topic

        -

        Running Mailjam

        -

        Next topic

        -

        Developers documentation

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/genindex.html =================================================================== --- docs/src/_build/html/genindex.html (revision 16) +++ (revision ) @@ -1,95 +1,0 @@ - - - - - - - - - - - - Index — Mailjam 0.1.0 documentation - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - - -

        Index

        - -
        - -
        - - -
        -
        -
        -
        -
        - - - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/index.html =================================================================== --- docs/src/_build/html/index.html (revision 27) +++ (revision ) @@ -1,156 +1,0 @@ - - - - - - - - - - Mailjam official documentation — Mailjam 0.1.0 documentation - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - - -
        -

        Indices and tables¶

        - -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Next topic

        -

        Overview of mailjam’s architecture

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/install.html =================================================================== --- docs/src/_build/html/install.html (revision 27) +++ (revision ) @@ -1,380 +1,0 @@ - - - - - - - - - - Installation instructions — Mailjam 0.1.0 documentation - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Installation instructions¶

        -

        Installing Mailjam is quite easy. If you have some experience installing -Python packages [1], you already know how to do it. Mailjam is a standard -Python package available on pypi [3] so just use your favourite tool -(pip, easy_install, etc) to intall it.

        -

        Keep reading if you want to learn more about the different options/choices -you have when installing Mailjam.

        - -
        -

        First, install dependencies¶

        -

        So far, the only dependency you will need in order to run mailjam is Python

        -

        Mailjam has been tested with python 2.7.x, but it should work with versions -2.6.x too.

        -

        Please, refer to your operating system documentation to learn more about how -to install python.

        -
        -
        -

        Second, install Mailjam¶

        -

        You can install Mailjam using one of the available tools for installing Python -packages, or you can install it from sources. Keep reading to learn more about -it.

        -
        -

        Installing using pip¶

        -

        You can install Mailjam using pip:

        -
        pip install Mailjam
        -
        -
        -

        Note

        -

        The previous command will install the latest release from pypi. If you -would like to install the latest bleeding edge sources (unstable code), -you can do it using pip too:

        -
        pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
        -
        -
        -
        -
        -

        Installing using easy_install¶

        -

        You can install Mailjam using easy_install:

        -
        easy_install Mailjam
        -
        -
        -
        -

        Installing inside a virtualenv¶

        -

        You can install Mailjam inside a virtualenv. Just create a virtualenv:

        -
        virtualenv /path/to/your/env
-
        -
        -

        Then activate it:

        -
        source /path/to/your/env/bin/activate
-
        -
        -
        -

        Note

        -

        If your shell is csh/tcsh remember you have to activate the -environment this way:

        -
        source /path/to/your/env/bin/activate.csh
-
        -
        -
        -

        And, once the environment has been activated, use pip to install Mailjam:

        -
        env$ pip install Mailjam
        -
        -
        -

        Note

        -

        Remember that you can install the latest bleeding edge version using -pip too:

        -
        env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
        -
        -
        -
        -
        -

        Installing from sources¶

        -

        When installing from sources, you can download one of the official releases -or you can go with the bleeding edge and get a copy of the official source -code repository.

        -
        -

        Releases¶

        -

        You can grab a copy of the latest release from pypi:

        -

        http://pypi.python.org/packages/source/m/mailjam/

        -

        After downloaded, you have to unpack the sources:

        -
        tar -zxvvf mailjam-0.1.0.tar.gz
        -
        -

        This will create a directory called mailjam-0.1.0, go inside that directory -and run:

        -
        python setup.py install
        -
        -
        -

        Warning

        -

        If you want to install it system-wide, probably you will need root -privileges (check your OS documentation to learn more about how to get -root privileges - for example using sudo)

        -
        -
        -

        Note

        -

        This process will work inside a virtualenv too.

        -
        -
        -
        -

        From repository¶

        -

        The source code of Mailjam is hosted in bitbucket [2]. In order to grab -the latest sources you need Mercurial.

        -

        To get a copy of the sources, just clone the repository:

        -
        hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
        -
        -

        Then, go inside the mailjam-repo directory and run:

        -
        python setup.py install
        -
        -
        -

        Warning

        -

        If you want to install it system-wide, probably you will need root -privileges (check your OS documentation to learn more about how to get -root privileges - for example using sudo)

        -
        -
        -

        Note

        -

        This process will work inside a virtualenv too.

        -
        -
        -
        -
        -
        -

        Setting up Mailjam¶

        -

        In order to setup Mailjam, you will have to create the needed -configuration files. Each component has its own -configuration file:

        - -

        Refer to each configuration file documentation to learn more about the different -settings you can customize.

        -

        Each component will search for its configuration file in a list of predefined -locations, but you can override that behaviour using the -c parameter when -starting the component.

        -
        -

        Note

        -

        Mailjam will search for the config files, in order, through the following -paths:

        -
          -
        1. /etc/mailjam
          2. -
        2. /etc
          3. -
        3. /usr/local/etc/mailjam
          4. -
        4. /usr/local/etc
          5. -
        5. the conf directory within the sources (or the installed egg [4])
          6. -
        -
        -

        For example, you can start the Mailjam daemon passing -/var/db/mailjam/mailjam.conf as its configuration file:

        -
        mailjam-server -c /var/db/mailjam/mailjam.conf
-
        -
        -
        -

        See also

        -

        Running Mailjam contains more information about how to run the different -components.

        -
        -

        If you have installed Mailjam using pip, easy_install or even from sources, -the setup process should have taken care of the configuration files, adding -a copy of the default files included in the sources to the default -destination.

        -
        -

        Warning

        -

        The default destination will be different based on your operating system. -For example, in most linux servers it will copy the files to /etc/mailjam, -while in BSD servers it will copy the files to /usr/local/etc/mailjam.

        -
        -
        -

        See also

        -

        Configuration files, settings and formats documentation

        -
        -
        -
        -

        Running Mailjam¶

        -

        In order to run a full Mailjam environment, you will have to start the different -components separately:

        -
          -
        1. Start the daemon
          2. -
        2. Run the cli client and manage your mailing lists
          3. -
        3. Add as much MTA clients as you need to your mail server
          4. -
        -

        The daemon will have to be running all the time (it is the component responsible -for providing information to the clients). You will need the CLI client to add, -edit or delete mailing lists and each MTA client will be responsible to handle -incoming emails for each mailing list.

        -
        -
        -

        Running tests (developers only)¶

        -

        Just in case you were wondering, yes, Mailjam code has some tests you can -run to check everything is ok and that the software should run smoothly on your -server(s).

        -

        To run the tests, simply get a copy of the sources from our public repository:

        -
        hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
        -
        -

        then run the tests:

        -
        cd mailjam-repo && ./bin/run_tests
        -
        - - - - - -
        [1]http://docs.python.org/tutorial/modules.html#packages
        - - - - - -
        [2]https://bitbucket.org/codigo23/mailjam
        - - - - - -
        [3]http://pypi.python.org/pypi/mailjam
        - - - - - -
        [4]http://svn.python.org/projects/sandbox/trunk/setuptools/doc/formats.txt
        -
        -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Previous topic

        -

        Overview of mailjam’s architecture

        -

        Next topic

        -

        Configuration

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/overview.html =================================================================== --- docs/src/_build/html/overview.html (revision 27) +++ (revision ) @@ -1,183 +1,0 @@ - - - - - - - - - - Overview of mailjam’s architecture — Mailjam 0.1.0 documentation - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Overview of mailjam’s architecture¶

        - -
        -

        Introduction¶

        -

        Mailjam has been designed following a multi-component structure. There is -a daemon that manage the mailing lists and members information in a storage -backend and there are different kinds of clients (currently, three of them) -that interact with the daemon using a XMLRPC link.

        -

        This is the scheme of the architecture:

        -Scheme of the architecture behind Mailjam -

        This architecture works for small setups (everything running on a single server) -but it works for bigger/larger installations with up to N mail servers, running -each server its own MTA client (or multiple instances -of it) to connect to N Mailjam daemon servers (managed locally -or remotely using up to N CLI client or -Web client instances).

        -
        -

        See also

        -

        The examples documentation contains some useful examples -about different kinds of setups.

        -
        -
        -
        -

        Mailjam daemon¶

        -

        The daemon will perform all the operations regarding the management of the -mailing lists and members. The daemon will save information of a given -mailing list to the storage backend, and will read information of already -saved lists from there too.

        -

        It listens for incoming XMLRPC requests on a given tcp port, allowing clients -to add/update/delete data from the backend.

        -
        -
        -

        MTA client¶

        -

        This client is attached to a given MTA, and is called but the MTA itself when -emails for a mailing lists are received. The client performs some checks on the -backend to tell the MTA what it has to do with the incoming emails.

        -
        -
        -

        CLI client¶

        -

        This is a shell-like interface that can be used to add mailing lists to a given -Mailjam server, edit such mailing lists information, add members, etc.

        -
        -
        -

        Web client¶

        -

        This is a small webapp that can be used to perform the same management -operations you can achieve using the -CLI client.

        -
        -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Previous topic

        -

        Mailjam official documentation

        -

        Next topic

        -

        Installation instructions

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/running.html =================================================================== --- docs/src/_build/html/running.html (revision 27) +++ (revision ) @@ -1,465 +1,0 @@ - - - - - - - - - - Running Mailjam — Mailjam 0.1.0 documentation - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Running Mailjam¶

        -

        In order to run Mailjam, you have to run the different components, depending on -what you want to do. Basically, you will need to run a server -(Mailjam daemon) all the time, then you will need one -MTA client per mailing list.

        -

        Ocasionally, you will need to add or delete a mailing list, or edit its -information, members list, etc. To do that, you will have to run a Mailjam -client (either the CLI client or the -Web client).

        -

        Keep reading if you want to learn more about the way you can start each -component, the different arguments/parameters you can provide on startup, etc.

        -
        -

        Warning

        -

        Remember that, before being able to run any component, you have to -set up proper configuration files. You -can learn more about Mailjam configuration files in the -configuration files documentation.

        -
        - -
        -

        The daemon¶

        -

        First component you should start is the Mailjam daemon. It is -quite easy, just run this command from a shell/console:

        -
        mailjam-server
-
        -
        -

        The server process will read the mailjam.conf -configuration file, will prepare everything and will start listening for XMLRPC -requests on localhost:9876

        -
        -

        Warning

        -

        localhost:9876 is the default value provided by the default configuration -files. If you have modified that, it will be a different address:port -combination.

        -
        -
        -

        Warning

        -

        If you didn’t add a valid configuration file to one of the -default paths, the server will refuse to -start, giving you an error message.

        -
        -
        -

        Warning

        -

        As of the current version of Mailjam, there are no pre-made init scripts that -can handle the start/stop/restart of the daemon, but those will be added in -one of the future releases.

        -
        -
        -

        Additional parameters¶

        -

        You can pass some parameters to mailjam-server to modify the behaviour of -the daemon or get more information.

        -
        -

        Note

        -

        Remember that the proper way to modify the behaviour of the daemon is -editing its configuration file, mailjam.conf

        -
        -
        -

        –help¶

        -

        You can get some help by passing the -h or –help parameters:

        -
        mailjam-server -h
-
        -
        -
        mailjam-server --help
-
        -
        -
        -
        -

        –config¶

        -

        You can set the path to the config file the server will load on startup, -passing the -c or –config parameters:

        -
        mailjam-server -c /home/mailjam/mailjam.conf
-
        -
        -
        mailjam-server --config /home/mailjam/mailjam.conf
-
        -
        -
        -

        Warning

        -

        If the file does not exist, or if it is not a valid configuration file, -an error will be shown and the daemon will refuse to start.

        -
        -
        -
        -

        –version¶

        -

        You can check the version of the mailjam server you are trying to run by -passing the -v or –version parameters:

        -
        mailjam-server -v
-
        -
        -
        mailjam-server --version
-
        -
        -
        -
        -
        - -
        -

        The MTA client¶

        -

        Once you have your daemon running, you have to add -as many MTA clients as mailing lists you -want to manage to your mail server.

        -
        -

        Quick configuration (you are a mail-servers-master)¶

        -

        Edit your mail server aliases file [1] (probably /etc/aliases or -/etc/mail/aliases) and add an entry like:

        -
        list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -"
        -
        -
        -

        Warning

        -

        replace list@mydomain.com with the real address of your mailing list

        -
        -
        -

        Warning

        -

        replace /usr/local/bin/mailjam-mta with the real path to your mailjam-mta -installation

        -
        -

        Rebuild your aliases database:

        -
        newaliases
-
        -
        -
        -

        Warning

        -

        Refer to your OS documentation to see how you can rebuild aliases. In most -unix-like systems it is done by the newaliases [2] command.

        -
        -
        -
        -

        Explained configuration (you really want to know what’s happening here)¶

        -

        When new messages arrive at your mail server for your mailing list address -(let’s use the example address list@mydomain.com) one of the steps in the -process that checks the message, it’s origin, destination, contents, etc is -the step where the mail server checks its internal aliases database, that is, -a list of special addresses that, instead of being real addresses, they are -related to some other addresses in some way.

        -

        Most MTAs out there support one very convenient feature that is to pipe the -contents of the message (headers and body) to a given shell command. That means -that the all the received data will be sent to an external command for it to -process such data.

        -

        Here is where mailjam-mta comes in.

        -

        What you have to do is just tell your mail server that all messages with -destination list@mydomain.com (to keep using the same example address) will be -piped to mailman-mta. The Mailjam MTA client will then know what to do with -the message, performing some checks and re-sending it to the proper destinations -(the members/suscriptors of the given mailing list).

        -

        So, first thing you have to find out is where is your aliases file?.

        -

        In unix-like systems, like the different Linux distributions or the different -BSD flavours, that file is /etc/mail/aliases or /etc/aliases (usually one is -a simbolic link to the other).

        -
        -

        Note

        -

        Usually the aliases file contains some lines like:

        -
        MAILER-DAEMON: postmaster
-postmaster: root
        -
        -
        -

        Once you’ve found out where the file is, edit it and add this line to the bottom -of the file:

        -
        list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -"
        -
        -
        -

        Warning

        -

        replace list@mydomain.com with the real address of your mailing list

        -
        -
        -

        Warning

        -

        replace /usr/local/bin/mailjam-mta with the real path to your mailjam-mta -installation

        -
        -

        There you are telling your mail server that any message coming to -list@mydomain.com will be passed to the mailjam-mta command, passing some -parameters to it:

        -
          -
        • -a list@mydomain.com tells mailjam-mta that the message is actually for -that mailing list. The MTA client will then use that value to check (against -the mailjam daemon) if it is a valid mailing list.
          • -
        • -i - tells mailjam-mta that the message will be piped directly. This is -important, as mailjam-mta can read the messages from files, but in this case -the mail server will pipe the data directly to mailjam-mta.
          • -
        -

        Once you’ve added that line to your aliases file, you have to rebuild your -aliases database:

        -
        newaliases
-
        -
        -
        -

        Warning

        -

        Refer to your OS documentation to see how you can rebuild aliases. In most -unix-like systems it is done by the newaliases [2] command.

        -
        -

        And you are done. Everything is ready now.

        -
        -
        -

        Additional parameters¶

        -

        You can pass some parameters to mailjam-mta to modify the behaviour of -the client or get more information.

        -
        -

        Note

        -

        Remember that the proper way to modify the behaviour of the client is -editing its configuration file, -mailjam-mta.conf

        -
        -
        -

        –help¶

        -

        You can get some help by passing the -h or –help parameters:

        -
        mailjam-mta -h
-
        -
        -
        mailjam-mta --help
-
        -
        -
        -
        -

        –config¶

        -

        You can set the path to the config file the client will load on startup, -passing the -c or –config parameters:

        -
        mailjam-mta -c /home/mailjam/mailjam-mta.conf
-
        -
        -
        mailjam-mta --config /home/mailjam/mailjam-mta.conf
-
        -
        -
        -

        Warning

        -

        If the file does not exist, or if it is not a valid configuration file, -an error will be shown and the client will refuse to start.

        -
        -
        -
        -

        –version¶

        -

        You can check the version of the mailjam client you are trying to run by -passing the -v or –version parameters:

        -
        mailjam-mta -v
-
        -
        -
        mailjam-mta --version
-
        -
        -
        -
        -

        –address (required)¶

        -

        This parameter is required (you have to provide it with a value in order to -run the mailjam-mta). It sets the address of the mailing list managed by this -MTA client instance.

        -

        The MTA client will use the provided value to do some checks on the daemon, -retrieving all the needed data to perform its tasks.

        -

        You can pass a valid address using both the -a and –address parameters:

        -
        mailjam-mta -a list@mydomain.com
        -
        -
        mailjam-mta --address list@mydomain.com
        -
        -
        -
        -

        –input¶

        -

        This parameter tells mailjam-mta from where it has to read the message sent -to the mailing list. That could be a local file (to be readed from disk) or -a stream of data coming directly from the standard input (stdin).

        -

        For a regular configuration/setup, the second option is preferred, as the mail -server will send the stream of data directly to mailjam-mta (as -explained before):

        -
        mailjam-mta -i -
        -
        -
        mailjam-mta --input -
        -
        -

        But perhaps some time you would like to send (again) a message you have on disk, -that could be done easily, passing the path to the file containing that message -to mailjam-mta:

        -
        mailjam-mta -i /home/backups/mail/that-important-mail.txt
-
        -
        -
        mailjam-mta -input /home/backups/mail/that-important-mail.txt
-
        -
        -
        -
        -
        - -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Previous topic

        -

        Configuration

        -

        Next topic

        -

        Some examples

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/search.html =================================================================== --- docs/src/_build/html/search.html (revision 16) +++ (revision ) @@ -1,99 +1,0 @@ - - - - - - - - - - Search — Mailjam 0.1.0 documentation - - - - - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -

        Search

        -
        - -

        - Please activate JavaScript to enable the search - functionality. -

        -
        -

        - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. -

        -
        - - - -
        - -
        - -
        - -
        -
        -
        -
        -
        -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U.. - Created using Sphinx 1.1.2. -
        - - Index: cs/src/_build/html/searchindex.js =================================================================== --- docs/src/_build/html/searchindex.js (revision 27) +++ (revision ) @@ -1,1 +1,0 @@ -Search.setIndex({objects:{},terms:{mydomain:3,code:5,edg:5,queri:[3,6],all:[2,3,6,5],follow:[2,5],netbsd:6,disk:[3,6],ssl_crt:6,categori:6,privat:6,depend:[1,3,6,5],newalias:3,send:[3,6],init:3,archlinux:6,sent:[3,6],sourc:[6,5],everi:6,fals:6,simbol:3,veri:3,run_test:5,administr:6,list:[1,3,6,5,2],upload:[],"try":[3,6],small:2,prepar:3,pleas:5,pasa:[],second:[1,3,5],design:2,pass:[3,5],download:5,port:[2,3,6],even:5,index:1,what:[2,3,6],postman:[],section:6,abl:[3,6],current:[2,3,6],delet:[2,3,5],version:[3,5],"new":[3,6],"public":[6,5],hasn:6,full:5,themselv:6,gener:6,here:[3,6],behaviour:[3,6,5],let:3,trunk:5,path:[3,6,5],modifi:[3,6],valu:[3,6],overview_mailjam_cli_cli:[],search:[1,5],larger:2,host:5,appli:6,app:6,prefer:3,unix:3,instal:[1,3,6,5,2],txt:[3,5],establish:6,from:[2,3,6,5],stream:3,would:[3,6,5],regist:6,call:[2,5],usr:[3,6,5],taken:5,type:6,tell:[2,3,6],more:[3,6,5],registr:6,relat:3,warn:[3,6,5],indic:1,unpack:5,retriev:3,setup:[2,3,6,5],work:[2,6,5],histori:6,archiv:6,can:[2,3,6,5],learn:[3,5],root:[3,5],overrid:5,favourit:5,tar:5,give:3,process:[3,6,5],sudo:5,accept:6,want:[3,6,5],multipl:2,csh:5,travel:6,how:[3,5],anyon:6,env:5,instead:3,config:[3,5],updat:[2,6],gentoo:6,stop:3,clone:5,after:[6,5],befor:3,data:[2,3,6],man:3,stdin:3,combin:3,alias:3,sandbox:5,codigo23:5,allow:[2,6],egg:5,order:[3,6,5],origin:3,help:3,offici:[1,5],becaus:6,through:[6,5],still:6,dynam:6,paramet:[3,6,5],style:6,cli:[1,3,6,5,2],mailing_list:6,persist:6,mail:[1,3,6,5,2],them:2,thei:[3,6],uniform_resource_identifi:6,handl:[3,5],auto:6,now:[3,6],bigger:2,introduct:[1,2],choic:5,edit:[2,3,5],didn:3,separ:[6,5],easili:3,achiev:2,each:[2,3,5],found:3,secure_socket_lay:6,mean:[3,6],mailjam:[1,3,6,5,2],replac:[3,6],realli:[3,6],connect:[2,6],our:5,happen:3,special:3,out:3,shown:3,tcsh:5,suscriptor:3,overview_mailjam_mta_cli:[],content:[0,1,2,3,4,5,6],insid:5,given:[2,3,6],standard:[3,5],quick:3,base:[6,5],releas:[3,5],org:[3,6,5],bleed:5,care:5,could:[3,6],refus:3,keep:[3,5],thing:3,perhap:3,first:[1,3,5],oper:[2,5],softwar:[1,5],directli:3,onc:[3,5],instruct:[1,5],alreadi:[2,5],done:3,messag:[3,6],predefin:5,differ:[2,3,6,5],script:3,interact:[2,6],system:[3,6,5],construct:6,mercuri:5,attach:2,master:3,too:[2,6,5],conveni:3,store:6,listen:[2,3,6],shell:[2,3,5],consol:3,option:[3,6,5],tool:5,copi:[6,5],setuptool:5,allow_chpasswd:6,kept:6,zxvvf:5,serv:6,wide:5,kind:[2,6],scheme:2,instanc:[2,3],remot:2,remov:6,requir:3,structur:2,project:5,matter:6,were:5,pre:3,unencrypt:6,argument:3,packag:5,have:[3,6,5],tabl:1,need:[3,6,5],inform:[2,3,6,5],note:[3,6,5],also:[2,6,5],client:[1,3,6,5,2],take:6,environ:5,noth:6,singl:2,sure:6,freebsd:[3,6],previou:5,auto_signup:6,most:[3,6,5],regular:3,bsd:[3,6,5],url:[],doc:[6,5],later:6,request:[2,3,6],uri:6,configguration_xmlrpc:[],pipe:3,latest:5,ssl_kei:6,session:6,find:3,xml:6,configuration_xmlrpc:[],onli:[1,6,5],locat:[6,5],execut:6,explain:3,configur:[1,3,6,5],activ:5,should:[3,5],local:[2,3,6,5],get:[3,5],pypi:5,tbw:4,repo:5,ssl:6,restart:3,enabl:6,crt:6,provid:[3,6,5],contain:[2,3,6,5],privileg:5,grab:5,where:[3,6],wiki:[3,6],certif:6,set:[1,3,6,5],startup:3,see:[2,3,6,5],respons:5,wonder:5,awar:6,databas:3,user:6,wikipedia:[3,6],email_alia:3,written:[1,6],"import":3,experi:5,email:[2,6,5],kei:6,extens:6,webapp:2,come:3,addit:3,bodi:3,pymotw:6,doughellmann:6,against:3,configpars:6,etc:[2,3,6,5],tutori:5,mani:3,com:[3,6],load:3,simpli:5,overview:[1,2],address:[3,6],por:6,arriv:3,header:3,rpc:6,linux:[3,6,5],backend:[2,6],quit:[3,5],mailman:3,rebuild:3,three:2,been:[2,6,5],compon:[2,3,5],json:6,much:5,basic:3,both:3,ani:[3,6],those:[3,6],"case":[3,5],multi:2,look:6,intal:5,trick:6,"while":5,error:3,overview_mailjam_daemon:[],bin:[3,5],readi:[3,6],destin:[3,5],itself:2,conf:[1,3,6,5],incom:[2,6,5],develop:[0,1,5],fedora:6,perform:[2,3],same:[2,3,6],member:[2,3,6],python:[1,6,5],html:[6,5],document:[0,1,2,3,5,6],http:[3,6,5],hostnam:6,logfil:6,extern:3,task:3,off:[],entri:3,inherit:6,exampl:[1,3,4,5,2],command:[3,6,5],thi:[1,3,6,5,2],everyth:[2,3,5],ubuntu:6,usual:[3,6],identifi:6,just:[3,5],tcp:2,yet:6,ocasion:3,web:[1,3,6,2],easi:[3,5],add:[2,3,6,5],valid:3,input:3,save:[2,6],modul:[1,5],real:3,applic:6,xmlrpc:[2,3,6],format:5,read:[2,3,6,5],traffic:6,know:[3,5],password:6,daemon:[1,3,6,5,2],like:[2,3,6,5],specif:6,server:[2,3,6,5],unstabl:5,either:3,manag:[1,3,5,2],www:[3,6],right:6,members_db:6,some:[1,3,4,5,2],intern:[3,6],smoothli:5,proper:3,home:3,librari:6,distribut:3,virtualenv:5,bottom:3,per:[3,6],localhost:[3,6],refer:[3,6,5],cgi:3,run:[1,3,5,2],step:3,repositori:5,about:[2,3,6,5],actual:3,page:1,backup:3,disabl:6,own:[2,5],within:[6,5],easy_instal:5,storag:[2,6],your:[3,6,5],log:6,wai:[3,6,5],support:[3,6],custom:5,avail:[6,5],start:[3,5],interfac:[2,6],includ:5,"var":[6,5],mailer:3,properli:6,regard:2,link:[2,3],line:3,"true":6,reset:6,made:3,flavour:3,"default":[3,6,5],until:[],record:[],below:6,mta:[1,3,6,5,2],postmast:3,featur:[3,6],openbsd:6,ini_fil:6,creat:5,doesn:6,exist:[3,6],ini:6,file:[1,3,6,5],pip:5,doe:[3,6],check:[2,3,6,5],probabl:[3,5],again:3,encrypt:6,when:[2,3,6,5],lists_db:6,other:[3,6],futur:3,rememb:[3,5],varieti:6,test:[1,5],you:[2,3,6,5],architectur:[1,2],debian:6,svn:5,bitbucket:5,receiv:[2,3],directori:[6,5],xmlrpc_server:6,ignor:6,time:[3,5],far:5},objtypes:{},titles:["Developers documentation","Mailjam official documentation","Overview of mailjam’s architecture","Running Mailjam","Some examples","Installation instructions","Configuration"],objnames:{},filenames:["development","index","overview","running","examples","install","configuration"]}) Index: cs/src/conf.py =================================================================== --- docs/src/conf.py (revision 16) +++ (revision ) @@ -1,285 +1,0 @@ -# -*- coding: utf-8 -*- -# -# Mailjam documentation build configuration file, created by -# sphinx-quickstart on Sun May 20 12:34:00 2012. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Mailjam' -copyright = u'2012, Soluciones Informaticas Codigo23 S.L.U.' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.1.0' -# The full version, including alpha/beta/rc tags. -release = '0.1.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Mailjamdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Mailjam.tex', u'Mailjam Documentation', - u'Soluciones Informaticas Codigo23 S.L.U.', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'mailjam', u'Mailjam Documentation', - [u'Soluciones Informaticas Codigo23 S.L.U.'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'Mailjam', u'Mailjam Documentation', - u'Soluciones Informaticas Codigo23 S.L.U.', 'Mailjam', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'Mailjam' -epub_author = u'Soluciones Informaticas Codigo23 S.L.U.' -epub_publisher = u'Soluciones Informaticas Codigo23 S.L.U.' -epub_copyright = u'2012, Soluciones Informaticas Codigo23 S.L.U.' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True Index: cs/src/configuration.rst =================================================================== --- docs/src/configuration.rst (revision 27) +++ (revision ) @@ -1,607 +1,0 @@ -Configuration -============= - -Mailjam has separate configuration files for the different apps (the daemon and -the variety of different clients available). Check below to read more about the -configuration file you need to modify depending on what you want to do. - -.. contents:: - -.. _configuration_daemon: - -Mailjam daemon configuration file - mailjam.conf ------------------------------------------------- - -All the configurations that can be applied to the :ref:`overview_mailjam_daemon` -are registered in the **mailjam.conf** file. That file contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam.conf file will be installed in different locations depending on - your setup. The usual locations are: - - - */etc/mailjam/mailjam.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam.conf* - In most BSD systems (like FreeBSD, - OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_daemon_xmlrpc: - -xmlrpc_server -+++++++++++++ - -This section contains the configuration parameters that modify the behaviour of -the daemon when serving content through XMLRPC [2]_. - -These are all the available parameters in this section: - -.. _configuration_daemon_xmlrpc_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon will be listening for XMLRPC requests. Use ``*`` -to listen an all available addresses, or any specific ``hostname`` or -``ip address`` value. - -.. _configuration_daemon_xmlrpc_port: - -port -**** - -Default: ``9876`` - -The port where the daemon will be listening por XMLRPC requests. - -.. _configuration_daemon_xmlrpc_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ support in the daemon. If ``false`` all the traffic -to/from the server will travel unencrypted. If ``true`` all the traffic will -travel encrypted. - -.. _configuration_daemon_xmlrpc_ssl_key: - -ssl_key -******* - -Default: ``/usr/local/etc/mailjam/ssl/mailjam.key`` - -Path to the ssl key used for encrypted SSL sessions. - -.. warning:: - - This parameter is not used right now, as ssl support hasn't been added yet) - -.. _configuration_daemon_xmlrpc_ssl_crt: - -ssl_crt -******* - -Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt`` - -Path to the ssl certificate used for encrypted SSL sessions. - -.. warning:: - - This parameter is not used right now, as ssl support hasn't been added yet) - -.. _configuration_daemon_xmlrpc_logfile: - -logfile -******* - -Default: ``/var/log/mailjam/xmlrpc_server.log`` - -Path to the file where log messages will be saved - -.. _configuration_daemon_storage: - -storage -+++++++ - -This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends. - -These are all the available parameters in this section: - -.. _configuration_daemon_storage_backend: - -backend -******* - -Default: ``json`` - -Sets the type of backend the daemon is going to use. Right now the only backend -available is ``json``. - -.. _configuration_daemon_xmlrpc_path: - -path -**** - -Default: ``/usr/local/mailjam/storage`` - -Path to the directory where the backend will save data. - -.. _configuration_daemon_storage_lists_db: - -lists_db -******** - -Default: ``/usr/local/mailjam/storage/mailings.json`` - -Path to the file where the identifiers of existing mailing lists will be saved. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - lists_db = %(path)s/mailings.%(backend)s - - That means that the parameter will inherit the values of the base path and - the extension of the file from the *storage.path* and *storage.backend* - settings. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. _configuration_daemon_xmlrpc_members_db: - -members_db -********** - -Default: ``/usr/local/mailjam/storage/members.json`` - -Path to the file where the identifiers of existing members will be saved. - -.. note:: - - The same notes as for the *lists_db* parameter apply to this configuration - parameter. - -.. _configuration_daemon_archive: - -archive -+++++++ - -This section contains the configuration parameters that modify the way the -daemon saves data to disk, using one of the storage backends. - -These are all the available parameters in this section: - -.. _configuration_daemon_archive_enabled: - -enabled -******* - -Default: ``true`` - -Enables/disables the *archives* feature. When enabled, Mailjam saves copies of -email address into an *archive*, so they can be read later, through a web -interface. - -To disable that feature, set this to ``false``. - -.. warning:: - - This feature is not ready yet, so it doesn't matter if you set this to true - or false - -.. _configuration_daemon_archive_backend: - -backend -******* - -Default: ``json`` - -Sets the type of backend used to store messages into the archive. - -.. warning:: - - This feature is not ready yet. - -.. _configuration_daemon_archive_path: - -path -**** - -Default: ``/usr/local/mailjam/archives`` - -Path to the directory where the archives will be saved. - -.. warning:: - - This feature is not ready yet. - -.. _configuration_daemon_mailing_lists: - -mailing_lists -+++++++++++++ - -This section contains the configuration parameters that set the default -behaviour for mailing lists. - -.. warning:: - - This parameters are not currently used in mailjam, we are still working - on per-mailing-list configuration parameters. - -These are all the available parameters in this section: - -.. _configuration_daemon_mailing_lists_private: - -private -******* - -Default: ``true`` - -Sets if a given mailing list is *private* (only registered members can send -messages to the list) or not (anyone can send messages to the list). - -If ``false``, by default all new lists will not be private. - -.. _configuration_daemon_members: - -members -+++++++ - -This section contains the configuration parameters that set the default -behaviour for members. - -.. warning:: - - This parameters are not currently used in mailjam, we are still working - on per-member configuration parameters. - -These are all the available parameters in this section: - -.. _configuration_daemon_members_auto_signup: - -auto_signup -*********** - -Default: ``false`` - -Enables/disables auto-registration of members to mailing lists through a public -web application. If ``true``, users can register themselves into mailing lists -using a public web interface. If ``false``, only mailing lists administrators -will be able to add new members to the list. - -.. _configuration_daemon_members_allow_chpasswd: - -allow_chpasswd -************** - -Default: ``false`` - -Enables/disables the option to update passwords by the members themselves. - -If ``true``, members of a mailing list will be able to update their passwords -using a public web interface. If ``false``, only mailing lists administrators -will be able to reset those passwords. - -.. _configuration_mta_client: - -Mailjam MTA client configuration file - mailjam-mta.conf --------------------------------------------------------- - -This file contains all the parameters to configure the -:ref:`overview_mailjam_mta_client` properly. It contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam-mta.conf file will be installed in different locations - depending on your setup. The usual locations are: - - - */etc/mailjam/mailjam-mta.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam-mta.conf* - In most BSD systems (like - FreeBSD, OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_mta_client_server: - -server -++++++ - -This section contains the configuration parameters that tell the MTA client -where to connect when trying to interact with the -:ref:`overview_mailjam_daemon`. - -These are all the available parameters in this section: - -.. _configuration_mta_client_server_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to. - -.. _configuration_mta_client_server_port: - -port -**** - -Default: ``9876`` - -The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to. - -.. _configuration_mta_client_server_uri: - -uri -*** - -Default: http://localhost:9876 - -This is the URI [4]_ to where the client will connect to. It is constructed -based on the values of the :ref:`configuration_mta_client_server_address` -and :ref:`configuration_mta_client_server_port` parameters. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - uri = http://%(address)s:%(port)s - - That means that the parameter will inherit the values from the - :ref:`configuration_mta_client_server_address` - and :ref:`configuration_mta_client_server_port` parameters. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. warning:: - - You can replace this with any URI you would like, **this is the parameter - that is really used for establishing new connections** so be aware that if - you remove the references to the - :ref:`configuration_mta_client_server_address` and - :ref:`configuration_mta_client_server_port` parameters, the values you have - provided for those parameters will be ignored. - -.. _configuration_mta_client_server_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ connections to the daemon. If ``false`` all the -traffic to/from the server will travel unencrypted. If ``true`` all the traffic -will travel encrypted. - -.. warning:: - - In order to enable SSL support in the client, you have to be sure the - :ref:`overview_mailjam_daemon` supports SSL too (check the - :ref:`configuration_daemon_xmlrpc_ssl` parameter in the - :ref:`configuration_daemon_xmlrpc` section of the - :ref:`daemon configuration file `) - -.. _configuration_mta_client_archive: - -archive -+++++++ - -This section contains the configuration parameters that set where the files -generated by the client will be stored/saved. - -.. seealso:: - - For more information about the kind of files the client does generate, - take a look at the - :ref:`MTA client documentation `. - -These are all the available parameters in this section: - -.. _configurtion_mta_client_archive_persistent: - -persistent -********** - -Default: ``true`` - -Enables/disables the local archive for the client. If ``true``, the client -will save a copy of every email sent to the list in an internal archive, -that could be checked/queried later. If ``false``, the emails will not be -kept on disk after being processed. - -.. warning:: - - This feature is not ready yet. - - -.. _configuration_mta_client_archive_path: - -path -**** - -Default: ``/usr/local/mailjam/archive-mta`` - -Path to the directory where the archives will be saved. - -.. warning:: - - This feature is not ready yet. - - -.. _configuration_cli_client: - -Mailjam CLI client configuration file - mailjam-cli.conf --------------------------------------------------------- - -This file contains all the parameters to configure the -:ref:`overview_mailjam_cli_client` properly. It contains ini-style [1]_ -configuration parameters, separated in different *categories*. - -.. note:: - - The mailjam-cli.conf file will be installed in different locations - depending on your setup. The usual locations are: - - - */etc/mailjam/mailjam-cli.conf* - In most Linux systems (like archlinux, - gentoo, fedora, debian, ubuntu, etc) - - - */usr/local/etc/mailjam/mailjam-cli.conf* - In most BSD systems (like - FreeBSD, OpenBSD, NetBSD, etc) - - There is a copy of the configuration file in the *conf/* directory, within - the sources. - -.. _configuration_cli_client_server: - -server -++++++ - -This section contains the configuration parameters that tell the cli client -where to connect when trying to interact with the -:ref:`overview_mailjam_daemon`. - -These are all the available parameters in this section: - -.. _configuration_cli_client_server_address: - -address -******* - -Default: ``localhost`` - -The address where the daemon is listening for XMLRPC requests. This is -the address to where the client will try to connect to. - -.. _configuration_cli_client_server_port: - -port -**** - -Default: ``9876`` - -The port where the daemon accepts incoming XMLRPC requests. This is the -port to where the client will try to connect to. - -.. _configuration_cli_client_server_uri: - -uri -*** - -Default: http://localhost:9876 - -This is the URI [4]_ to where the client will connect to. It is constructed -based on the values of the :ref:`configuration_cli_client_server_address` -and :ref:`configuration_cli_client_server_port` parameters. - -.. note:: - - The default configuration file contains a dynamic setting for this - parameter:: - - uri = http://%(address)s:%(port)s - - That means that the parameter will inherit the values from the - :ref:`configuration_cli_client_server_address` - and :ref:`configuration_cli_client_server_port` parameters. - -.. seealso:: - - More information about this (and other tricks) here: - - http://docs.python.org/library/configparser.html - - http://www.doughellmann.com/PyMOTW/ConfigParser - -.. warning:: - - You can replace this with any URI you would like, **this is the parameter - that is really used for establishing new connections** so be aware that if - you remove the references to the - :ref:`configuration_cli_client_server_address` and - :ref:`configuration_cli_client_server_port` parameters, the values you have - provided for those parameters will be ignored. - -.. _configuration_cli_client_server_ssl: - -ssl -*** - -Default: ``false`` (because ssl support hasn't been added yet) - -Enables/disables SSL [3]_ connections to the daemon. If ``false`` all the -traffic to/from the server will travel unencrypted. If ``true`` all the traffic -will travel encrypted. - -.. warning:: - - In order to enable SSL support in the client, you have to be sure the - :ref:`overview_mailjam_daemon` supports SSL too (check the - :ref:`configuration_daemon_xmlrpc_ssl` parameter in the - :ref:`configuration_daemon_xmlrpc` section of the - :ref:`daemon configuration file `) - -.. _configuration_cli_client_history: - -history -+++++++ - -This section contains the configuration parameters that set the behaviour -of the client feature that allows it to save a history of commands provided -by the user. - -These are all the available parameters in this section: - -.. _configurtion_cli_client_archive_enabled: - -enabled -******* - -Default: ``true`` - -Enables/disables history support in the client. If ``true`` all commands -provided by an user will be saved to disk. If ``false`` nothing will be -written to disk. - -.. _configuration_cli_client_history_path: - -path -**** - -Default: ``~/.mailjam/cli/history`` - -Path to the file where the list of executed commands will be saved. - - -.. [1] http://en.wikipedia.org/wiki/INI_file -.. [2] http://en.wikipedia.org/wiki/XML-RPC -.. [3] http://en.wikipedia.org/wiki/Secure_Socket_Layer -.. [4] http://en.wikipedia.org/wiki/Uniform_resource_identifier Index: cs/src/development.rst =================================================================== --- docs/src/development.rst (revision 13) +++ (revision ) @@ -1,4 +1,0 @@ -Developers documentation -======================== - -.. contents:: Index: cs/src/examples.rst =================================================================== --- docs/src/examples.rst (revision 27) +++ (revision ) @@ -1,6 +1,0 @@ -Some examples -============= - -.. contents:: - -TBW Index: cs/src/index.rst =================================================================== --- docs/src/index.rst (revision 16) +++ (revision ) @@ -1,28 +1,0 @@ -Mailjam official documentation -============================== - -This is the official documentation for Mailjam_, a mailing list management -software written in Python_. - -Contents: - -.. toctree:: - :maxdepth: 2 - - overview - install - configuration - running - examples - development - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. _Mailjam: https://bitbucket.org/codigo23/mailjam -.. _Python: http://python.org Index: cs/src/install.rst =================================================================== --- docs/src/install.rst (revision 27) +++ (revision ) @@ -1,271 +1,0 @@ -Installation instructions -========================= - -Installing Mailjam is quite easy. If you have some experience installing -Python_ packages [1]_, you already know how to do it. Mailjam is a standard -Python_ package available on pypi_ [3]_ so just use your favourite tool -(pip_, easy_install_, etc) to intall it. - -Keep reading if you want to learn more about the different options/choices -you have when installing Mailjam. - -.. contents:: - -.. _install_dependencies: - -First, install dependencies ---------------------------- - -So far, the only dependency you will need in order to run mailjam is Python_ - -Mailjam has been tested with python *2.7.x*, but it should work with versions -*2.6.x* too. - -Please, refer to your operating system documentation to learn more about how -to install python. - -.. _install_mailjam: - -Second, install Mailjam ------------------------ - -You can install Mailjam using one of the available tools for installing Python_ -packages, or you can install it from sources. Keep reading to learn more about -it. - -.. _install_with_pip: - -Installing using pip -++++++++++++++++++++ - -You can install Mailjam using pip_:: - - pip install Mailjam - -.. note:: - - The previous command will install the latest release from pypi_. If you - would like to install the latest *bleeding edge* sources (unstable code), - you can do it using pip_ too:: - - pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -.. _install_with_easy_install: - -Installing using easy_install -+++++++++++++++++++++++++++++ - -You can install Mailjam using easy_install_:: - - easy_install Mailjam - -.. _install_inside_virtualenv: - -Installing inside a virtualenv -++++++++++++++++++++++++++++++ - -You can install Mailjam inside a virtualenv_. Just create a virtualenv:: - - virtualenv /path/to/your/env - -Then activate it:: - - source /path/to/your/env/bin/activate - -.. note:: - - If your shell is **csh**/**tcsh** remember you have to activate the - environment this way:: - - source /path/to/your/env/bin/activate.csh - -And, once the environment has been activated, use pip to install Mailjam:: - - env$ pip install Mailjam - -.. note:: - - Remember that you can install the latest *bleeding edge* version using - pip_ too:: - - env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam - -.. _install_from_sources: - -Installing from sources -+++++++++++++++++++++++ - -When installing from sources, you can download one of the official releases -or you can go with the *bleeding edge* and get a copy of the official source -code repository. - -.. _install_from_release: - -Releases -******** - -You can grab a copy of the latest release from pypi_: - -http://pypi.python.org/packages/source/m/mailjam/ - -After downloaded, you have to unpack the sources:: - - tar -zxvvf mailjam-0.1.0.tar.gz - -This will create a directory called *mailjam-0.1.0*, go inside that directory -and run:: - - python setup.py install - -.. warning:: - - If you want to install it *system-wide*, probably you will need *root* - privileges (check your OS documentation to learn more about how to get - *root* privileges - for example using sudo_) - -.. note:: - - This process will work inside a virtualenv_ too. - -.. _install_from_repository: - -From repository -*************** - -The source code of Mailjam is hosted in bitbucket_ [2]_. In order to grab -the latest sources you need Mercurial_. - -To get a copy of the sources, just *clone* the repository:: - - hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo - -Then, go inside the *mailjam-repo* directory and run:: - - python setup.py install - -.. warning:: - - If you want to install it *system-wide*, probably you will need *root* - privileges (check your OS documentation to learn more about how to get - *root* privileges - for example using sudo_) - -.. note:: - - This process will work inside a virtualenv_ too. - -.. _install_setting_up_mailjam: - -Setting up Mailjam ------------------- - -In order to setup Mailjam, you will have to create the needed -:doc:`configuration files `. Each component has its own -configuration file: - -- The :ref:`Mailjam daemon ` configuration file is - :ref:`mailjam.conf ` - -- The :ref:`Mailjam MTA client ` configuration - file is :ref:`mailjam-mta.conf ` - -- The :ref:`Mailjam CLI client ` configuration - file is :ref:`mailjam-cli.conf ` - -Refer to each configuration file documentation to learn more about the different -settings you can customize. - -Each component will search for its configuration file in a list of predefined -locations, but you can override that behaviour using the *-c* parameter when -starting the component. - -.. note:: - - Mailjam will search for the config files, in order, through the following - paths: - - 1. /etc/mailjam - - 2. /etc - - 3. /usr/local/etc/mailjam - - 4. /usr/local/etc - - 5. the *conf* directory within the sources (or the installed *egg* [4]_) - -For example, you can start the :ref:`overview_mailjam_daemon` passing -*/var/db/mailjam/mailjam.conf* as its configuration file:: - - mailjam-server -c /var/db/mailjam/mailjam.conf - -.. seealso:: - - :doc:`running` contains more information about how to run the different - components. - -If you have installed Mailjam using pip_, easy_install_ or even from sources, -the setup process should have taken care of the configuration files, adding -a copy of the default files included in the sources to the default -destination. - -.. warning:: - - The default destination will be different based on your operating system. - For example, in most linux servers it will copy the files to */etc/mailjam*, - while in BSD servers it will copy the files to */usr/local/etc/mailjam*. - -.. seealso:: - - :doc:`Configuration files, settings and formats documentation ` - - -.. _install_running_mailjam: - -Running Mailjam ---------------- - -In order to run a full Mailjam environment, you will have to start the different -components separately: - -1. :ref:`Start the daemon ` - -2. :ref:`Run the cli client and manage your mailing lists ` - -3. :ref:`Add as much MTA clients as you need to your mail server` - -The daemon will have to be running all the time (it is the component responsible -for providing information to the clients). You will need the CLI client to add, -edit or delete mailing lists and each MTA client will be responsible to handle -incoming emails for each mailing list. - -.. _install_running_tests: - -Running tests (developers only) -------------------------------- - -Just in case you were wondering, **yes**, Mailjam code has some tests you can -run to check everything is ok and that the software should run smoothly on your -server(s). - -To run the tests, simply get a copy of the sources from our public repository:: - - hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo - -then run the tests:: - - cd mailjam-repo && ./bin/run_tests - - -.. _Python: http://python.org -.. _pip: http://www.pip-installer.org/en/latest/index.html -.. _pypi: http://pypi.python.org/pypi -.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall -.. _virtualenv: http://www.virtualenv.org/en/latest/index.html -.. _bitbucket: https://bitbucket.org -.. _Mercurial: http://mercurial.selenic.com -.. _sudo: http://sudo.ws - -.. [1] http://docs.python.org/tutorial/modules.html#packages -.. [2] https://bitbucket.org/codigo23/mailjam -.. [3] http://pypi.python.org/pypi/mailjam -.. [4] http://svn.python.org/projects/sandbox/trunk/setuptools/doc/formats.txt Index: cs/src/overview.rst =================================================================== --- docs/src/overview.rst (revision 27) +++ (revision ) @@ -1,69 +1,0 @@ -Overview of mailjam's architecture -================================== - -.. contents:: - -Introduction ------------- - -Mailjam has been designed following a **multi-component structure**. There is -**a daemon** that manage the mailing lists and members information in a storage -backend and there are **different kinds of clients** (currently, three of them) -that **interact with the daemon using a XMLRPC link**. - -This is the scheme of the architecture: - -.. image:: /mailjam_architecture.png - :alt: Scheme of the architecture behind Mailjam - :class: open_fancybox - -This architecture works for small setups (everything running on a single server) -but it works for bigger/larger installations with up to N mail servers, running -each server its own :ref:`overview_mailjam_mta_client` (or multiple instances -of it) to connect to N :ref:`overview_mailjam_daemon` servers (managed locally -or remotely using up to N :ref:`overview_mailjam_cli_client` or -:ref:`overview_mailjam_web_client` instances). - -.. seealso:: - - :doc:`The examples documentation ` contains some useful examples - about different kinds of setups. - -.. _overview_mailjam_daemon: - -Mailjam daemon --------------- - -The daemon will perform all the operations regarding the management of the -mailing lists and members. The daemon will save information of a given -mailing list to the storage backend, and will read information of already -saved lists from there too. - -It listens for incoming XMLRPC requests on a given tcp port, allowing clients -to add/update/delete data from the backend. - -.. _overview_mailjam_mta_client: - -MTA client ----------- - -This client is attached to a given MTA, and is called but the MTA itself when -emails for a mailing lists are received. The client performs some checks on the -backend to tell the MTA what it has to do with the incoming emails. - -.. _overview_mailjam_cli_client: - -CLI client ----------- - -This is a shell-like interface that can be used to add mailing lists to a given -Mailjam server, edit such mailing lists information, add members, etc. - -.. _overview_mailjam_web_client: - -Web client ----------- - -This is a small *webapp* that can be used to perform the same management -operations you can achieve using the -:ref:`CLI client`. Index: cs/src/running.rst =================================================================== --- docs/src/running.rst (revision 27) +++ (revision ) @@ -1,354 +1,0 @@ -Running Mailjam -=============== - -In order to run Mailjam, you have to run the different components, depending on -what you want to do. Basically, you will need to run a server -(:ref:`overview_mailjam_daemon`) all the time, then you will need one -:ref:`overview_mailjam_mta_client` per mailing list. - -Ocasionally, you will need to add or delete a mailing list, or edit its -information, members list, etc. To do that, you will have to run a Mailjam -client (either the :ref:`CLI client ` or the -:ref:`Web client `). - -Keep reading if you want to learn more about the way you can start each -component, the different arguments/parameters you can provide on startup, etc. - -.. warning:: - - Remember that, before being able to run any component, you have to - :ref:`set up proper configuration files `. You - can learn more about Mailjam configuration files in the - :doc:`configuration files documentation `. - -.. contents:: - -.. _running_daemon: - -The daemon ----------- - -First component you should start is the :ref:`overview_mailjam_daemon`. It is -quite easy, just run this command from a shell/console:: - - mailjam-server - -The server process will read the :ref:`mailjam.conf ` -configuration file, will prepare everything and will start listening for XMLRPC -requests on *localhost:9876* - -.. warning:: - - *localhost:9876* is the default value provided by the default configuration - files. If you have modified that, it will be a different *address:port* - combination. - -.. warning:: - - If you didn't add a valid configuration file to one of the - :ref:`default paths `, the server will refuse to - start, giving you an error message. - -.. warning:: - - As of the current version of Mailjam, there are no pre-made init scripts that - can handle the start/stop/restart of the daemon, but those will be added in - one of the future releases. - -.. _running_daemon_parameters: - -Additional parameters -+++++++++++++++++++++ - -You can pass some parameters to *mailjam-server* to modify the behaviour of -the daemon or get more information. - -.. note:: - - Remember that the proper way to modify the behaviour of the daemon is - editing its configuration file, :ref:`mailjam.conf ` - -.. _running_daemon_help: - ---help -****** - -You can get some help by passing the *-h* or *--help* parameters:: - - mailjam-server -h - -:: - - mailjam-server --help - -.. _running_daemon_config: - ---config -******** - -You can set the path to the config file the server will load on startup, -passing the *-c* or *--config* parameters:: - - mailjam-server -c /home/mailjam/mailjam.conf - -:: - - mailjam-server --config /home/mailjam/mailjam.conf - -.. warning:: - - If the file does not exist, or if it is not a valid configuration file, - an error will be shown and the daemon will refuse to start. - -.. _running_daemon_version: - ---version -********* - -You can check the version of the mailjam server you are trying to run by -passing the *-v* or *--version* parameters:: - - mailjam-server -v - -:: - - mailjam-server --version - - -.. _running_cli_client: - -The CLI client --------------- - - - -.. _running_mta_client: - -The MTA client --------------- - -Once you have your :ref:`daemon running `, you have to add -as many :ref:`MTA clients ` as mailing lists you -want to manage to your mail server. - -.. _running_mta_client_quick: - -Quick configuration (you are a mail-servers-master) -+++++++++++++++++++++++++++++++++++++++++++++++++++ - -Edit your mail server aliases file [1]_ (probably */etc/aliases* or -*/etc/mail/aliases*) and add an entry like:: - - list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -" - -.. warning:: - - replace *list@mydomain.com* with the real address of your mailing list - -.. warning:: - - replace */usr/local/bin/mailjam-mta* with the real path to your mailjam-mta - installation - -Rebuild your *aliases* database:: - - newaliases - -.. warning:: - - Refer to your OS documentation to see how you can rebuild *aliases*. In most - unix-like systems it is done by the newaliases [2]_ command. - -.. _running_mta_client_explained: - -Explained configuration (you really want to know what's happening here) -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -When new messages arrive at your mail server for your mailing list address -(let's use the example address *list@mydomain.com*) one of the steps in the -process that checks the message, it's origin, destination, contents, etc is -the step where the mail server checks its internal *aliases* database, that is, -a list of *special* addresses that, instead of being *real* addresses, they are -related to some other addresses in some way. - -Most MTAs out there support one very *convenient* feature that is to *pipe* the -contents of the message (headers and body) to a given shell command. That means -that the all the received data will be sent to an external command for it to -process such data. - -**Here is where mailjam-mta comes in**. - -What you have to do is just tell your mail server that all messages with -destination *list@mydomain.com* (to keep using the same example address) will be -*piped* to mailman-mta. The Mailjam MTA client will then know what to do with -the message, performing some checks and re-sending it to the proper destinations -(the members/suscriptors of the given mailing list). - -So, first thing you have to find out is **where is your aliases file?**. - -In unix-like systems, like the different Linux distributions or the different -BSD flavours, that file is */etc/mail/aliases* or */etc/aliases* (usually one is -a simbolic link to the other). - -.. note:: - - Usually the aliases file contains some lines like:: - - MAILER-DAEMON: postmaster - postmaster: root - -Once you've found out where the file is, edit it and add this line to the bottom -of the file:: - - list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -" - -.. warning:: - - replace *list@mydomain.com* with the real address of your mailing list - -.. warning:: - - replace */usr/local/bin/mailjam-mta* with the real path to your mailjam-mta - installation - -There you are telling your mail server that any message coming **to** -*list@mydomain.com* will be passed to the mailjam-mta command, passing some -parameters to it: - -- **-a list@mydomain.com** tells mailjam-mta that the message is actually for - that mailing list. The MTA client will then use that value to check (against - the mailjam daemon) if it is a valid mailing list. - -- **-i -** tells mailjam-mta that the message will be *piped* directly. This is - important, as mailjam-mta can read the messages from files, but in this case - the mail server will *pipe* the data directly to mailjam-mta. - -Once you've added that line to your *aliases* file, you have to rebuild your -*aliases* database:: - - newaliases - -.. warning:: - - Refer to your OS documentation to see how you can rebuild *aliases*. In most - unix-like systems it is done by the newaliases [2]_ command. - -And you are done. Everything is ready now. - -.. _running_mta_client_parameters: - -Additional parameters -+++++++++++++++++++++ - -You can pass some parameters to *mailjam-mta* to modify the behaviour of -the client or get more information. - -.. note:: - - Remember that the proper way to modify the behaviour of the client is - editing its configuration file, - :ref:`mailjam-mta.conf ` - -.. _running_mta_client_help: - ---help -****** - -You can get some help by passing the *-h* or *--help* parameters:: - - mailjam-mta -h - -:: - - mailjam-mta --help - -.. _running_mta_client_config: - ---config -******** - -You can set the path to the config file the client will load on startup, -passing the *-c* or *--config* parameters:: - - mailjam-mta -c /home/mailjam/mailjam-mta.conf - -:: - - mailjam-mta --config /home/mailjam/mailjam-mta.conf - -.. warning:: - - If the file does not exist, or if it is not a valid configuration file, - an error will be shown and the client will refuse to start. - -.. _running_mta_client_version: - ---version -********* - -You can check the version of the mailjam client you are trying to run by -passing the *-v* or *--version* parameters:: - - mailjam-mta -v - -:: - - mailjam-mta --version - -.. _running_mta_client_address: - ---address (required) -******************** - -This parameter is required (you have to provide it with a value in order to -run the mailjam-mta). It sets the address of the mailing list managed by this -MTA client instance. - -The MTA client will use the provided value to do some checks on the daemon, -retrieving all the needed data to perform its tasks. - -You can pass a valid address using both the *-a* and *--address* parameters:: - - mailjam-mta -a list@mydomain.com - -:: - - mailjam-mta --address list@mydomain.com - -.. _running_mta_client_input: - ---input -******* - -This parameter tells mailjam-mta from where it has to read the message sent -to the mailing list. That could be a local file (to be readed from disk) or -a stream of data coming directly from the standard input (*stdin*). - -For a regular configuration/setup, the second option is preferred, as the mail -server will send the stream of data directly to mailjam-mta (as -:ref:`explained before `):: - - mailjam-mta -i - - -:: - - mailjam-mta --input - - -But perhaps some time you would like to send (again) a message you have on disk, -that could be done easily, passing the path to the file containing that message -to mailjam-mta:: - - mailjam-mta -i /home/backups/mail/that-important-mail.txt - -:: - - mailjam-mta -input /home/backups/mail/that-important-mail.txt - - -.. _running_web_client: - -The Web client --------------- - -.. [1] http://en.wikipedia.org/wiki/Email_alias -.. [2] http://www.freebsd.org/cgi/man.cgi?query=newaliases Index: iljam/__init__.py =================================================================== --- mailjam/__init__.py (revision 33) +++ (revision ) @@ -1,16 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - A small mailing list manager - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -__version__ = '0.1.1' - -from mailjam.models import Member, MailingList -from mailjam.storage import JsonStorage Index: iljam/archives/README =================================================================== --- mailjam/archives/README (revision 16) +++ (revision ) @@ -1,1 +1,0 @@ -Default archives location Index: iljam/cli.py =================================================================== --- mailjam/cli.py (revision 25) +++ (revision ) @@ -1,233 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - cli.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os, cmd, xmlrpclib -from mailjam.config import CLIClientConfig - -class CLIClient(cmd.Cmd): - - def __init__(self, configfile=None, *args, **kwargs): - cmd.Cmd.__init__(self) - cli_config = CLIClientConfig(configfile=configfile) - cli_config.load() - self.config = cli_config.config - self.rpc = xmlrpclib.ServerProxy(self.config['server']['uri']) - self.prompt = "mailjam-cli > " - self.intro = "Welcome to Mailjam's CLI client - type help for a list of commands" - self._history = [] - - def do_history(self, line): - """ - history - Show a list of recently executed commands - - Alias: h - """ - if not self._history: - print 'No history data available' - else: - for i in self._history: - print self._history.index(i), ' - ', i - - def do_h(self, line): - """ - h - Alias for the history command. To learn more type: - - help history - """ - self.do_history(line) - - def do_add_mailing_list(self, line): - """ - add_mailing_list [name] address - Add a new mailing list to the remote mailjam server. You have to - provide a valid email address for the mailing list to be added. If no - name is provided, the address itself will be used. - - Alias: aml - """ - if not line: - print 'usage: add_mailing_list [name] address' - else: - params = line.split(' ') - address = params.pop() - if not params: - name = address - else: - name = ' '.join(params) - info = {'name': name, 'address': address, 'members': {}, - 'configfile': self.config['server']['configfile']} - result = self.rpc.lists.add(info) - print result - - def do_aml(self, line): - """ - aml [name] address - Alias for the add_mailing_list command. To learn more type: - - help add_mailing_list - """ - self.do_add_mailing_list(line) - - def do_list_mailing_lists(self, line): - """ - list_mailing_lists [text] - List the mailing lists available in the remote mailjam server. - If text is provided, only mailing lists whose address contains such - text will be shown. Otherwise all the available email addresses are - listed. - - Alias: lml - """ - addresses = self.rpc.lists.addresses() - if not line: - for address in addresses: - print address - else: - for address in addresses: - if line in address: - print address - - def do_lml(self, line): - """ - lml [text] - Alias for the list_mailing_lists command. To learn more type: - - help list_mailing_lists - """ - self.do_list_mailing_lists(line) - - def do_show_mailing_list(self, line): - """ - show_mailing_list address - Show detailed information of the mailing list represented by address. - - Alias: sml - """ - if not line: - print 'usage: show_mailing_list address' - else: - result = self.rpc.lists.info(line) - if isinstance(result, dict): - print 'Mailing list information:' - print ' - name:', result['name'] - print ' - address:', result['address'] - print ' - members:', result['members'] - else: - print result - - def do_sml(self, line): - """ - sml address - Alias for the show_mailing_list command. To learn more type: - - help show_mailing_list - """ - self.do_show_mailing_list(line) - - def do_add_mailing_list_member(self, line): - """ - add_mailing_list_member member_address list_address - Add a new member to a given mailing list. You have to provide valid - email addresses for both the member and the list. The mailing list - must be handled by the remote mailjam server for this operation to - work. - - Alias: amlm - """ - usage = 'usage: add_mailing_list_member member_address list_address' - if not line: - print usage - else: - params = line.split(' ') - list_addr = params.pop() - if params: - member_addr = params.pop() - result = self.rpc.members.add(member_addr, list_addr) - print result - else: - # we need the member adddress too - print usage - - def do_amlm(self, line): - """ - amlm member_address list_address - Alias for the add_mailing_list_member command. To learn more type: - - help add_mailing_list_member - """ - self.do_add_mailing_list_member(line) - - def do_list_mailing_list_members(self, line): - """ - list_mailing_list_members address - List all the members from the given list. - - Alias: lmlm - """ - if not line: - print 'usage: list_mailing_list_members address' - else: - members = self.rpc.members.list(line) - if not members: - print 'No members found in list', line - else: - print len(members), 'member(s) found in list', line - for m in members: - print m - - def do_lmlm(self, line): - """ - lmlm address - Alias for the list_mailing_list_members command. To learn more type: - - help list_mailing_lists - """ - self.do_list_mailing_list_members(line) - - def do_EOF(self, line): - return True - - def precmd(self, line): - # save the commands to the history, if it is enabled in the config file - if self.config['history']['enabled']: - self._history.append(line) - return line - - def postloop(self): - # save history to a file, if it is enabled in the config file. - if self.config['history']['enabled']: - history_file_name = self.config['history']['path'] - if '~' in history_file_name: - # we have to replace that with the proper home path - # FIXME: we should call some "sanitize" function here, to - # get rid of dangerous paths in the file name - home = os.path.expanduser("~") - history_file_name = history_file_name.replace('~', home) - if not os.path.exists(history_file_name): - try: - os.makedirs(os.path.dirname(history_file_name)) - except OSError, e: - # If the dir already exists do not complain, if it is - # any other error, raise the exception - if e.errno != errno.EEXIST: - raise - history_file = open(history_file_name, 'a') - for i in self._history: - if 'EOF' not in i: - history_file.write(i+'\n') - history_file.close() - print 'Bye!' - - def emptyline(self): - pass Index: iljam/config.py =================================================================== --- mailjam/config.py (revision 27) +++ (revision ) @@ -1,121 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - config.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os -from ConfigParser import SafeConfigParser - -class DaemonConfig(): - def __init__(self, configfile=None): - self.configfile = configfile - self.default_paths = ['/etc/mailjam', '/etc', - '/usr/local/etc/mailjam', '/usr/local/etc', - os.path.join(os.path.dirname(__file__),'../conf')] - self.config = {} - - @property - def default_filename(self): - """ - Method to get the default configuration filename. It is a method instead - of an attribute for easier subclassing - """ - return 'mailjam.conf' - - @property - def sections(self): - """ - Method to get the list of available sections in the configuration file. - It is a method instead of an attribute for easier subclassing. - - FIXME: Perhaps it would be better to dinamically get the list of - sections from the configuration file itself. - """ - return ['xmlrpc_server', 'storage', 'archive', - 'mailing_lists', 'members'] - - def validate_configfile(self): - if self.configfile: - # ensure we have the full path to the provided file - self.configfile = os.path.join(os.path.dirname(__file__), - self.configfile) - if not os.path.exists(self.configfile): - # the file does not exist, so we override it with None, - # allowing the next few lines to search for a valid - # config file on the usual places - self.configfile = None - else: - return self.configfile - - if not self.configfile: - for path in self.default_paths: - full_path = os.path.join(path, self.default_filename) - if os.path.exists(full_path): - self.configfile = full_path - return full_path - - # if we reach here, self.configfile will be still None, no valid - # config files were found, and so we raise an exception - raise IOError('ERROR - Can not find ' + self.default_filename + \ - ' in your environment') - - def load(self): - if not self.configfile: - self.validate_configfile() - parser = SafeConfigParser() - parser.read(self.configfile) - for section in self.sections: - self.config[section] = {} - for name, value in parser.items(section): - self.config[section][name] = value - return self.config - - def get_section_parameters(self, section): - if section not in self.sections: - raise IndexError('ERROR - ' + section + \ - ' is not one of the available sections: ' + \ - ', '.join(self.sections)) - if section not in self.config.keys(): - # perhaps the config hasn't been loaded yet - self.load() - - return self.config[section] - - -class MTAClientConfig(DaemonConfig): - @property - def default_filename(self): - return 'mailjam-mta.conf' - - @property - def sections(self): - return ['server', 'archive'] - - -class CLIClientConfig(DaemonConfig): - @property - def default_filename(self): - return 'mailjam-cli.conf' - - @property - def sections(self): - return ['server', 'history'] - - -def get_config_parameters(section=None, configfile=None): - """ - This function is kept here for backwards compatibility. - By default all the daemon code will use this function to get - configuration parameters from the default configuration file. - """ - config = DaemonConfig(configfile) - return config.get_section_parameters(section) - - Index: iljam/daemon.py =================================================================== --- mailjam/daemon.py (revision 33) +++ (revision ) @@ -1,276 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - daemon.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os, inspect, logging -from SimpleXMLRPCServer import SimpleXMLRPCServer, list_public_methods - -from mailjam import config -from mailjam.models import Member, MailingList -from mailjam.storage import JsonStorage as Storage - - -class Mailjam(): - - def __init__(self, configfile=None): - self.configfile=configfile - self.storage_config = config.get_config_parameters('storage', - configfile) - self.archive_config = config.get_config_parameters('archive', - configfile) - - # lists were the currently managed mailing lists information is going - # to be saved - self.mailings = {} - self.mailings_addresses = [] - - # the files were internal information (like active mailing lists, - # members, etc) is saved - self.dbs = {'mailings': Storage(self.storage_config['lists_db']), - 'members': Storage(self.storage_config['members_db'])} - - def save(self): - """ - Save all the current managed data to disk - """ - if self.mailings: - # Save the config file from where we can reload information about - # the mailing lists managed by this mailjam instance - self.dbs['mailings'].write(self.mailings_addresses) - # Save each mailing list data into its separated persistence file - for m in self.mailings.keys(): - self.mailings[m].save() - return True - return False - - def load(self): - """ - Load all data from the storage files - """ - if self.dbs['mailings'].exists(): - # load the list of managed mailing lists - # FIXME: This is quite naive, we do not perform any check here after - # loading the data from the json file, which can be modified by - # untrustred users. - self.mailings_addresses = self.dbs['mailings'].read() - - # now load all the mailing objects: - for address in self.mailings_addresses: - mailing = MailingList(name=address, address=address, - configfile=self.configfile) - mailing.load() - self.mailings[address] = mailing - return True - return False - - def clear(self): - """ - Delete all stored data from disk (useful for testing). - DANGER: Calling this method will remove all data from disk, leaving the - mailjam instance with no persistence data, if the mailjam process die, - before another .save() call is made, all data will be lost. - """ - if self.dbs['mailings'].exists(): - # We do not delete each mailing list file, but only the file - # containing the list of existing mailing lists - self.dbs['mailings'].delete() - return True - return False - - def add_mailing_list(self, info={}): - """ - Add a new mailing list to this mailjam instance. expects one parameter, - info, which is a dictionary that should contain, at least, the - following keys: - - - name: (string) the name we will give to the list - - address: (string) the email address of the list - - members: (list) a list of email adddress of the list members - - """ - if not isinstance(info, dict): - raise TypeError(info, ' is not a valid dictionary') - - if 'name' not in info.keys() or \ - 'address' not in info.keys() or \ - 'members' not in info.keys() or \ - 'configfile' not in info.keys(): - raise ValueError(info, ' does not seem to be a valid configuration') - - if info['address'] in self.mailings_addresses: - raise IndexError(info['address'], - ' has been already added to mailjam') - - mailing = MailingList(info['name'], info['address'], - info['members'], info['configfile']) - self.mailings[mailing.address] = mailing - self.mailings_addresses.append(mailing.address) - # After adding new mailings, save them to disk - self.save() - return True - - def add_mailing_member(self, member_addr=None, list_addr=None): - """ - Add a new member for the mailing list represented by list_addr (a string - containing the email address of any mailing list managed by this mailjam - instance). member_addr is a string representing the email address of the - new member - """ - - if not member_addr: - raise ValueError(member_addr, 'missing member address') - - if not list_addr: - raise ValueError(list_addr, 'missing list address') - - if list_addr not in self.mailings_addresses: - # FIXME: Perhaps we should add it, perhaps not (mispelled address?) - raise IndexError(list_addr, ' is not a valid mailing list') - - added = self.mailings[list_addr].add_member_by_address(member_addr) - if added: - self.save() - return added - - -class MailjamXMLRPC(): - """ - This class is a wrapper we will use to limit the methods that will be - published through the XMLRPC link. Only the methods from this class - will be available through that link. - - As we use dotted names to separate xmlrpc-exported methods into different - namespaces, this class contains nothing, it will be used only for - method-registering purposes. The MailingListXMLRPC and MemberXMLRPC classes - contain the actual methods that are published. - - More information on this approach here: - - http://www.doughellmann.com/PyMOTW/SimpleXMLRPCServer/#exposing-methods-of-objects - """ - - def __init__(self, configfile=None): - self.configfile = configfile - - def _listMethods(self): - public_methods = [] - public_methods += ['lists.'+i for i in dir(MailingListXMLRPC) \ - if '_' not in i] - public_methods += ['members.'+i for i in dir(MemberXMLRPC) \ - if '_' not in i] - return public_methods - - def _methodHelp(self, method): - f = getattr(self, method) - return inspect.getdoc(f) - - -class MailingListXMLRPC(): - def __init__(self, configfile=None): - self.mailjam = Mailjam(configfile=configfile) - self.mailjam.load() - def add(self, info={}): - try: - self.mailjam.add_mailing_list(info) - except IndexError, e: - return str(e) - return 'Added mailing list ' + info['address'] - def addresses(self): - return self.mailjam.mailings_addresses - def info(self, address): - if address not in self.mailjam.mailings_addresses: - return 'Mailing list not found - ' + address - return self.mailjam.mailings[address].info() - - -class MemberXMLRPC(): - def __init__(self, configfile=None): - self.mailjam = Mailjam(configfile=configfile) - self.mailjam.load() - def add(self, member_addr=None, list_addr=None): - # reload data to ensure we have recently added lists available - self.mailjam.load() - try: - self.mailjam.add_mailing_member(member_addr, list_addr) - except IndexError, e: - return str(e) - return 'Added member ' + member_addr + ' to ' + list_addr - def list(self, mailing): - if mailing in self.mailjam.mailings_addresses: - return self.mailjam.mailings[mailing].members_addresses() - return [] - - -class MailjamDaemon(): - def __init__(self, configfile=None): - self.configfile = configfile - self.config = config.get_config_parameters('xmlrpc_server', configfile) - self.address = self.config.get('address', 'localhost') - self.port = int(self.config.get('port', 9876)) - self.logfile = self.config.get('logfile', - os.path.join(os.path.dirname(__file__), - 'server.log')) - logging.basicConfig(filename=self.logfile, level=logging.DEBUG) - self.server = None - self.ready_to_serve = False - - def create_server(self): - """ - If there is no server initialized in self.server, create an instance - of SimpleXMLRPCServer in that attribute. If there is already a server - initialized there, simply return True - """ - if not self.server: - msg = 'Creating XMLRPC server object on {}:{}'.format(self.address, - self.port) - logging.info(msg) - self.server = SimpleXMLRPCServer((self.address, self.port), - allow_none=True, - logRequests=True) - self.server.register_introspection_functions() - return True - - def add_methods(self): - """ - Check if there is an initialized server (initialize it if there is none) - and then register all the Mailjam public methods to be served through - the xml-rpc link - - Once the methods are registered set self.ready_to_serve to True - """ - if not self.server: - # ensure there is an XMLRPC server initialized - self.create_server() - msg = 'Registering public methods' - logging.info(msg) - root = MailjamXMLRPC(self.configfile) - root.lists = MailingListXMLRPC(self.configfile) - root.members = MemberXMLRPC(self.configfile) - self.server.register_instance(root, allow_dotted_names=True) - self.ready_to_serve = True - return self.ready_to_serve - - def run(self): - """ - Run the xmlrpc daemon. If self.ready_to_serve is False, call - self.add_methods, which will initialize the server and will register all - the public methods into that server - """ - if not self.ready_to_serve: - self.add_methods() - msg = 'Starting XMLRPC server on {}:{}'.format(self.address, - self.port) - logging.info(msg) - try: - self.server.serve_forever() - except KeyboardInterrupt: - msg = 'Stopping server' - logging.info(msg) Index: iljam/models.py =================================================================== --- mailjam/models.py (revision 23) +++ (revision ) @@ -1,129 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - models.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os -from tools import validate_email_address -from storage import JsonStorage as Storage -import config - -class Member(): - - """ - Class that defines a mailing list member - """ - - def __init__(self, address): - self.address = self._validate_address(address) - - def __repr__(self): - return "" % self.address - - def __str__(self): - return self.address - - def _validate_address(self, address): - if not validate_email_address(address): - raise ValueError(str(address) + ' is not a valid email address') - return address - - -class MailingList(): - - """ - Class that defines a mailing list - """ - - def __init__(self, name, address, members={}, configfile=None): - self.configfile = configfile - self.storage_config = config.get_config_parameters('storage', - configfile) - self.archive_config = config.get_config_parameters('archive', - configfile) - self.mailing_config = config.get_config_parameters('mailing_lists', - configfile) - self.name = name - self.address = address - self.members = members - - def __repr__(self): - return "" % self.address - - def __str__(self): - return self.address - - def _validate_member_object(self, member=None): - if not isinstance(member, Member): - raise TypeError(str(member) + ' is not a valid Member instance') - return member - - def _validate_member(self, member=None): - member = self._validate_member_object(member) - return member.address in self.members_addresses() - - def _validate_member_by_address(self, address=None): - if not validate_email_address(address): - raise ValueError(str(address) + ' is not a valid email address') - return address in self.members_addresses() - - @property - def storage(self): - return Storage(os.path.join(self.storage_config['path'], self.address)) - - @property - def archive(self): - return Storage(os.path.join(self.archive_config['path'], self.address)) - - def members_addresses(self): - return self.members.keys() - - def add_member(self, member): - member = self._validate_member_object(member) - if self._validate_member(member): - return False - self.members[member.address] = member - return True - - def add_member_by_address(self, address=None): - if self._validate_member_by_address(address): - return False - member = Member(address) - self.members[address] = member - return True - - def delete_member(self, member=None): - member = self._validate_member_object(member) - if not self._validate_member(member): - return False - del self.members[member.address] - return True - - def info(self): - """ - Returns a dict we can use to add this mailing list to a mailjam - instance - """ - # FIXME: This code could be replaced with something that - # automagically generates the dict from the instance attributes - return {'name': self.name, 'address': self.address, - 'members': self.members, 'configfile': self.configfile} - - def load(self): - if self.storage.exists(): - data = self.storage.read() - self.name = data.name - self.address = data.address - self.members = data.members - return True - return False - - def save(self): - self.storage.write(self) Index: iljam/mta.py =================================================================== --- mailjam/mta.py (revision 26) +++ (revision ) @@ -1,111 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - mta.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os, sys, email, smtplib, xmlrpclib -from datetime import datetime -from mailjam.models import MailingList -from mailjam.config import MTAClientConfig -from mailjam.tools import validate_email_address - -class MTAClient(): - - def __init__(self, address=None, configfile=None): - if not validate_email_address(address): - raise ValueError(address, ' is not a valid email address') - - mta_config = MTAClientConfig(configfile=configfile) - mta_config.load() - self.config = mta_config.config - self.rpc = xmlrpclib.ServerProxy(self.config['server']['uri']) - self.address = self._validate_address(address) - self.suscriptors = self.rpc.members.list(address) - self.reply_to = self.address - self.raw_email = None - self.queue = [] - - def _validate_archive_path(self): - """ - Validate that the archive path exists. If not, try to create it - """ - if not os.path.exists(self.config['archive']['path']): - # FIXME: This will raise an IOError if the user has no - # privileges to create the directory, perhaps we should catch - # that and show an error instead - os.makedirs(self.config['archive']['path']) - return True - - def _validate_address(self, address=None): - """ - The address provided by the user will be valid only if it is a - valid email address and if it is the email address of an already - existing mailing list - """ - if not validate_email_address(address): - raise ValueError(address, ' is not a valid email address') - if not address in self.rpc.lists.addresses(): - raise ValueError(address, - ' is not the address of any existing mailing list') - # If it is valid, return it - return address - - def get_raw_email(self, raw_email=None): - """ - get the raw data containing email information. If raw_email is None, - try to get the data from stdin - """ - if not raw_email: - try: - self.raw_email = sys.stdin.read() - except: - raise IOError('Can not get a valid email from stdin') - else: - self.raw_email = raw_email - # FIXME: We should perform some checks on the raw data, ensuring - # it is a valid email text - return self.raw_email - - def save_raw_email(self): - if not self.raw_email: - # FIXME: perhaps a while loop here, with some maximum recursion - # check, would be nice here - self.get_raw_email() - # Check the path to the archive exists - self._validate_archive_path() - filename = os.path.join(self.config['archive']['path'], - datetime.today().strftime('%Y%d%m%H%M%S%f')) - tmpfile = file(filename, 'w') - tmpfile.write(self.raw_email) - tmpfile.close() - self.queue.append(filename) - - def send_email(self): - """ - Send emails from the queue, if there is any - """ - if self.queue: - next_email = self.queue.pop() - email_file = file(next_email, 'r') - email_data = email.message_from_file(email_file) - email_file.close() - email_data['Reply-to'] = self.reply_to - smtp_conn = smtplib.SMTP() - smtp_conn.connect() - smtp_conn.sendmail(email_data['From'], self.suscriptors, - email_data.as_string()) - smtp_conn.close() - # FIXME: enable tmp data removal here: - # if not self.config['archive']['persistent']: - # REMOVE THE FILE FROM DISK - - def run(self): - self.save_raw_email() - self.send_email() Index: iljam/storage.py =================================================================== --- mailjam/storage.py (revision 18) +++ (revision ) @@ -1,104 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - storage.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os, errno, json, inspect - - -class JsonStorage(): - - """ - Json-based storage. - """ - - def __init__(self, path='storage.json'): - if os.path.isdir(path): - raise IOError(path, ' is a directory, exiting') - self.path = path - - def exists(self): - return os.path.exists(self.path) - - def create(self): - """ - Ensure all the subdirectories in the path to the storage file - exist - """ - try: - os.makedirs(os.path.dirname(self.path)) - except OSError, e: - # If the dir already exists do not complain, if it is - # any other error, raise the exception - if e.errno != errno.EEXIST: - raise - - def jsonize(self, obj): - """ - Convert objects to a dictionary of their representation - Based on the exmplaes from Doyg Hellmann: - http://www.doughellmann.com/PyMOTW/json/#working-with-your-own-types - """ - jobj = { '__class__':obj.__class__.__name__, - '__module__':obj.__module__, - } - jobj.update(obj.__dict__) - return jobj - - def dejsonize(self, jobj): - """ - Convert some data that has been "jsonized" to the original - python object. Again, based on the examples from Doug Hellmann - """ - if '__class__' in jobj: - class_name = jobj.pop('__class__') - module_name = jobj.pop('__module__') - module = __import__(module_name) - class_ = getattr(module, class_name) - # inspect the class __init__ method, getting a list of - # accepted/valid arguments. - valid_args = inspect.getargspec(class_.__init__) - # then, only accepted parameters will be deserialized - args = dict((key.encode('ascii'), value) \ - for key, value in jobj.items() if key in valid_args[0]) - return class_(**args) - return jobj - - def write(self, data): - if not self.exists(): - # ensure the path to the storage file exists - self.create() - with open(self.path, 'w') as storage: - json.dump(data, storage, sort_keys=True, indent=4, - default=self.jsonize) - return True - return False - - def read(self): - with open(self.path, 'r') as storage: - try: - data = json.load(storage,object_hook=self.dejsonize) - except ValueError: - # if no json data could be imported, the file could be - # damaged or perhaps it does not containg json-encoded - # data, simply return an empty string - # - # FIXME: we should notify the user about the problem - return '' - return data - - def delete(self): - """ - Remove the storage file - """ - if self.exists(): - os.remove(self.path) - return True - return False Index: iljam/storage/README =================================================================== --- mailjam/storage/README (revision 16) +++ (revision ) @@ -1,1 +1,0 @@ -Default storage location Index: iljam/storage/mailings/README =================================================================== --- mailjam/storage/mailings/README (revision 16) +++ (revision ) @@ -1,1 +1,0 @@ -Default mailing list storage location Index: iljam/tests/__init__.py =================================================================== --- mailjam/tests/__init__.py (revision 16) +++ (revision ) @@ -1,15 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - tests module - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -from models import * -# from mta import * -from daemon import * Index: iljam/tests/daemon.py =================================================================== --- mailjam/tests/daemon.py (revision 16) +++ (revision ) @@ -1,202 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - daemon.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import os, multiprocessing, xmlrpclib, time -from SimpleXMLRPCServer import SimpleXMLRPCServer -from unittest import TestCase - -from mailjam.daemon import Mailjam, MailjamXMLRPC, MailjamDaemon -from mailjam.models import Member, MailingList -from mailjam.storage import JsonStorage as Storage - - -class TestMailjam(TestCase): - """ - mailjam.daemon.Mailjam tests. - - Remember to call the .clear() method of mailjam after each test, so - the temp storage files are deleted - """ - def setUp(self): - self.configfile = os.path.join(os.path.dirname(__file__), 'mailjam.conf') - self.mailing_list = MailingList('test_list', 'test_list@example.com', - members={}, configfile=self.configfile) - self.member = Member('test@example.com') - - def test___init__(self): - mailjam = Mailjam(configfile=self.configfile) - self.assertIsInstance(mailjam, Mailjam) - self.assertEqual(mailjam.mailings, {}) - self.assertEqual(mailjam.mailings_addresses, []) - self.assertIsInstance(mailjam.dbs, dict) - self.assertTrue('mailings' in mailjam.dbs.keys()) - self.assertTrue('members' in mailjam.dbs.keys()) - self.assertIsInstance(mailjam.dbs['mailings'], Storage) - self.assertIsInstance(mailjam.dbs['members'], Storage) - - def test_save(self): - mailjam = Mailjam(configfile=self.configfile) - self.assertFalse(mailjam.save()) - mailjam.add_mailing_list(self.mailing_list.info()) - self.assertTrue(mailjam.save()) - # FIXME: We have to test here that the generated json file - # contains the data it should contain - - # Clear the files created by the tests - mailjam.clear() - - def test_load(self): - mailjam = Mailjam(configfile=self.configfile) - self.assertFalse(mailjam.mailings) - self.assertFalse(mailjam.mailings_addresses) - self.assertFalse(mailjam.load()) - mailjam.add_mailing_list(self.mailing_list.info()) - self.assertTrue(mailjam.load()) - - # Check that another mailjam instance is able to load the saved data - mailjam_load = Mailjam(configfile=self.configfile) - self.assertFalse(mailjam_load.mailings) - self.assertFalse(mailjam_load.mailings_addresses) - mailjam_load.load() - self.assertTrue(mailjam_load.mailings) - self.assertIsInstance(mailjam_load.mailings, dict) - self.assertTrue(mailjam_load.mailings_addresses) - self.assertIsInstance(mailjam_load.mailings_addresses, list) - - # Clear the files created by the tests - mailjam.clear() - - def test_clear(self): - mailjam = Mailjam(configfile=self.configfile) - self.assertFalse(mailjam.clear()) - mailjam.add_mailing_list(self.mailing_list.info()) - self.assertTrue(mailjam.clear()) - - def test_add_mailing_list(self): - mailjam = Mailjam(configfile=self.configfile) - with self.assertRaises(TypeError): - # test improper info values - mailjam.add_mailing_list(['a list', 'is an', 'invalid parameter']) - mailjam.add_mailing_list(self.mailing_list) - with self.assertRaises(ValueError): - #test incomplete/missing info values - mailjam.add_mailing_list() - mailjam.add_mailing_list({'name': 'missing info'}) - mailjam.add_mailing_list({'address': 'missing info'}) - mailjam.add_mailing_list({'name': 'missing info', - 'address': 'missing info'}) - # test mailing lists can be added - self.assertTrue(mailjam.add_mailing_list(self.mailing_list.info())) - self.assertTrue(mailjam.mailings) - self.assertIsInstance(mailjam.mailings, dict) - self.assertTrue(mailjam.mailings_addresses) - self.assertIsInstance(mailjam.mailings_addresses, list) - with self.assertRaises(IndexError): - # test what happens when the mailing has been already added - mailjam.add_mailing_list(self.mailing_list.info()) - - # Clear the files created by the tests - mailjam.clear() - - def test_add_mailing_member(self): - mailjam = Mailjam(configfile=self.configfile) - mailjam.add_mailing_list(self.mailing_list.info()) - with self.assertRaises(ValueError): - # test what happens if we call the method without proper - # parameters - mailjam.add_mailing_member() - mailjam.add_mailing_member(None, None) - mailjam.add_mailing_member(None, 'test_list@example.net') - mailjam.add_mailing_member('test@example.net', None) - mailjam.add_mailing_member('test@example', 'test_list@example.net') - with self.assertRaises(IndexError): - # test if we try to add a member to a non-existing mailing list - mailjam.add_mailing_member('test@example.net', - 'test_list_b@example.net') - # Test adding a member - self.assertTrue(mailjam.add_mailing_member('test@example.net', - self.mailing_list.address)) - # Test trying to re-add that user - self.assertFalse(mailjam.add_mailing_member('test@example.net', - self.mailing_list.address)) - - # Clear the files created by the tests - mailjam.clear() - - -class TestMailjamDaemon(TestCase): - """ - mailjam.daemon.MailjamDaemon tests. - - Remember to call the .clear() method of mailjam after each test, so - the temp storage files are deleted - """ - def setUp(self): - self.configfile = os.path.join(os.path.dirname(__file__), - 'mailjam.conf') - self.mailing_list = MailingList('test_xmlrpc', - 'test_xmlrpc@example.com', members={}, - configfile=self.configfile) - self.member = Member('test@example.com') - - def test___init__(self): - daemon = MailjamDaemon(self.configfile) - self.assertIsInstance(daemon, MailjamDaemon) - self.assertFalse(daemon.ready_to_serve) - # FIXME: More tests should be added here once the configuration - # file feature is added - - def test_create_server(self): - daemon = MailjamDaemon(self.configfile) - daemon.port = 9001 - self.assertTrue(daemon.create_server()) - self.assertIsInstance(daemon.server, SimpleXMLRPCServer) - self.assertFalse(daemon.ready_to_serve) - - def test_add_methods(self): - daemon = MailjamDaemon(self.configfile) - daemon.port = 9002 - self.assertTrue(daemon.add_methods()) - self.assertTrue(daemon.ready_to_serve) - - daemon = MailjamDaemon(self.configfile) - daemon.port = 9003 - daemon.create_server() - self.assertTrue(daemon.add_methods()) - self.assertTrue(daemon.ready_to_serve) - - def test_run(self): - daemon = MailjamDaemon(self.configfile) - daemon.port = 9004 - # start the daemon in another process, so we can start communicating - # with itjobs = [] - p = multiprocessing.Process(target=daemon.run) - p.start() - - # Add a delay here to allow the server to be fully started before - # starting to send requests from the client - time.sleep(2) - - # FIXME: Hardcoded url here, should be picked from a config file - client = xmlrpclib.ServerProxy('http://localhost:9004') - - # Check that we can perform an XMLRPC call and that the list of - # available public methods contains the list of methods we have - # defined in our base XMLRPC class - set_class_methods = set(MailjamXMLRPC()._listMethods()) - set_xmlrpc_methods = set(client.system.listMethods()) - self.assertTrue(set_class_methods.issubset(set_xmlrpc_methods)) - - # Stop the server - p.terminate() - - Index: iljam/tests/mailjam-mta.conf =================================================================== --- mailjam/tests/mailjam-mta.conf (revision 16) +++ (revision ) @@ -1,13 +1,0 @@ -# -# mailjam-mta.conf - Mailjam MTA client configuration file -# - -[server] -address = localhost -port = 9100 # this port is hardcoded in tests/mta.py -uri = http://%(address)s:%(port)s -ssl = false - -[archive] -persistent = true -path = /tmp/mailjam-tests/mta/archive Index: iljam/tests/mailjam.conf =================================================================== --- mailjam/tests/mailjam.conf (revision 33) +++ (revision ) @@ -1,32 +1,0 @@ -# -# mailjam.conf - Mailjam configuration file -# -# IMPORTANT: This config file should be used only -# for testing purposes - -[xmlrpc_server] -address = localhost -port = 9876 -ssl = false -ssl_key = /usr/local/etc/mailjam/ssl/mailjam.key -ssl_crt = /usr/local/etc/mailjam/ssl/mailjam.crt -logfile = /tmp/mailjam-tests/xmlrpc_server.log -accesslog = /var/log/mailjam/access.log - -[storage] -backend = json -path = /tmp/mailjam-tests/storage -lists_db = %(path)s/mailings.%(backend)s -members_db = %(path)s/members.%(backend)s - -[archive] -enabled = true -backend = json -path = /tmp/mailjam-tests/archives - -[mailing_lists] -private = true - -[members] -auto_signup = false -allow_chpasswd = false Index: iljam/tests/models.py =================================================================== --- mailjam/tests/models.py (revision 16) +++ (revision ) @@ -1,98 +1,0 @@ -# -*- coding: utf-8 -*- - -import os -from unittest import TestCase -from mailjam.models import Member, MailingList - - -class TestMember(TestCase): - def setUp(self): - self.member = Member('test@example.com') - - def test__validate_address(self): - self.assertEqual(self.member._validate_address(self.member.address), - self.member.address) - with self.assertRaises(ValueError): - self.member._validate_address('notavalidemail') - - -class TestMailingList(TestCase): - def setUp(self): - configfile = os.path.join(os.path.dirname(__file__), 'mailjam.conf') - self.mailing_list = MailingList('test_list', 'test_list@example.com', - members={}, configfile=configfile) - self.member = Member('test@example.com') - - def test__validate_member_object(self): - self.assertEqual(self.mailing_list._validate_member_object(self.member), - self.member) - with self.assertRaises(TypeError): - self.mailing_list._validate_member_object(None) - self.mailing_list._validate_member_object('Not a member object') - self.mailing_list._validate_member_object(self.mailing_list) - - def test__validate_member(self): - # At first the member object is not a member of the list - self.assertFalse(self.mailing_list._validate_member(self.member)) - self.mailing_list.add_member(self.member) - self.assertTrue(self.mailing_list._validate_member(self.member)) - with self.assertRaises(TypeError): - self.mailing_list._validate_member(None) - self.mailing_list._validate_member('Not a member object') - self.mailing_list._validate_member(self.mailing_list) - - def test__validate_member_by_address(self): - self.assertFalse(self.mailing_list._validate_member_by_address(self.member.address)) - self.mailing_list.add_member(self.member) - self.assertTrue(self.mailing_list._validate_member_by_address(self.member.address)) - with self.assertRaises(ValueError): - self.mailing_list._validate_member_by_address(self.member) - self.mailing_list._validate_member_by_address(None) - self.mailing_list._validate_member_by_address('Not a member object') - self.mailing_list._validate_member_by_address(self.mailing_list) - - def test_members_addresses(self): - self.assertEqual(self.mailing_list.members_addresses(), []) - self.mailing_list.add_member(self.member) - self.assertTrue(self.member.address in \ - self.mailing_list.members_addresses()) - - def test_add_member(self): - self.assertTrue(self.mailing_list.add_member(self.member)) - self.assertTrue(self.member.address in \ - self.mailing_list.members_addresses()) - # check what happens if the member is already there: - self.assertFalse(self.mailing_list.add_member(self.member)) - # check what happens if we try to add something that is not - # a valid Member instance - with self.assertRaises(TypeError): - self.mailing_list.add_member(None) - self.mailing_list.add_member('Not a member object') - self.mailing_list.add_member(self.mailing_list) - - def test_add_member_by_address(self): - self.assertTrue(self.mailing_list.add_member_by_address(self.member.address)) - self.assertTrue(self.member.address in \ - self.mailing_list.members_addresses()) - # check what happens if the member is already there: - self.assertFalse(self.mailing_list.add_member_by_address(self.member.address)) - # check what happens if we try to add something that is not - # a valid Member instance - with self.assertRaises(ValueError): - self.mailing_list.add_member_by_address(self.member) - self.mailing_list.add_member_by_address(None) - self.mailing_list.add_member_by_address('Not a member object') - self.mailing_list.add_member_by_address(self.mailing_list) - - def test_delete_member(self): - self.assertFalse(self.mailing_list.delete_member(self.member)) - self.mailing_list.add_member(self.member) - self.assertTrue(self.member.address in \ - self.mailing_list.members_addresses()) - self.assertTrue(self.mailing_list.delete_member(self.member)) - self.assertFalse(self.member.address in \ - self.mailing_list.members_addresses()) - with self.assertRaises(TypeError): - self.mailing_list.delete_member(None) - self.mailing_list.delete_member('Not a member object') - self.mailing_list.delete_member(self.mailing_list) Index: iljam/tests/mta.py =================================================================== --- mailjam/tests/mta.py (revision 16) +++ (revision ) @@ -1,97 +1,0 @@ -# -*- coding: utf-8 -*- - -import os, sys, multiprocessing, time -from unittest import TestCase -from mailjam.mta import MTAClient -from mailjam.daemon import MailjamDaemon -from mailjam.models import Member, MailingList - - -class TestMTAClient(TestCase): - """ - FIXME: These are dummy tests, they cover almost nothing from the - real mailjam mta client (yet) - """ - def setUp(self): - self.mta_configfile = os.path.join(os.path.dirname(__file__), - 'mailjam-mta.conf') - self.configfile = os.path.join(os.path.dirname(__file__), - 'mailjam.conf') - self.mailing_list = MailingList('test_list', 'test_list@example.com', - members={}, configfile=self.configfile) - self.member = Member('test@example.com') - self.raw_email_file = os.path.join(os.path.dirname(__file__), - 'sample_raw_email.txt') - tmp_to_read = open(self.raw_email_file, 'r') - self.raw_email = tmp_to_read.read() - tmp_to_read.close() - - def test___init__(self): - # in order to start mta client instances, we need to have a mailjam - # daemon running on the background - # This should be added to the setUp() method, but then it would be - # more difficult to terminate the process after all the methods - # were called - daemon = MailjamDaemon(self.configfile) - daemon.port = 9100 - p = multiprocessing.Process(target=daemon.run) - p.start() - # Add a delay here to allow the server to be fully started before - # starting to send requests from the client - time.sleep(1) - - with self.assertRaises(ValueError): - mta = MTAClient(self.mailing_list, self.mta_configfile) - mta = MTAClient(self.member, self.mta_configfile) - mta = MTAClient(None, self.mta_configfile) - mta = MTAClient(self.mailing_list.address, self.mta_configfile) - self.assertTrue(isinstance(mta, MTAClient)) - self.assertEqual(mta.address, self.mailing_list.address) - self.assertEqual(mta.suscriptors, self.mailing_list.members_addresses) - self.assertEqual(mta.reply_to, self.mailing_list.address) - - p.terminate() - - def test_get_raw_email(self): - # in order to start mta client instances, we need to have a mailjam - # daemon running on the background - # This should be added to the setUp() method, but then it would be - # more difficult to terminate the process after all the methods - # were called - daemon = MailjamDaemon(self.configfile) - daemon.port = 9100 - p = multiprocessing.Process(target=daemon.run) - p.start() - # Add a delay here to allow the server to be fully started before - # starting to send requests from the client - time.sleep(1) - - mta = MTAClient(self.mailing_list.address, self.mta_configfile) - - sys_stdin = sys.stdin - sys.stdin = open(self.raw_email_file, 'r') - self.assertEqual(mta.get_raw_email(), - self.raw_email) - sys.stdin.close() - with self.assertRaises(IOError): - mta.get_raw_email() - - tmp_file= open(self.raw_email_file('r')) - raw_data = tmp_file.read() - tmp_file.close() - self.assertEqual(mta.get_raw_email(raw_data), - self.raw_email) - - p.terminate() - - #def save_raw_email(self): - # sys_stdin = sys.stdin - # sys.stdin = open(self.raw_email_file, 'r') - # self.mta.save_raw_email.filename = '/tmp/mailjam-test-mta-save-raw-email' - - - - - - - Index: iljam/tests/sample_raw_email.txt =================================================================== --- mailjam/tests/sample_raw_email.txt (revision 16) +++ (revision ) @@ -1,179 +1,0 @@ -From root@fenrir.codigo23.lab Mon May 14 03:22:20 2012 -Return-Path: -Received: from fenrir.codigo23.lab (localhost [127.0.0.1]) - by fenrir.codigo23.lab (8.14.5/8.14.5) with ESMTP id q4D1MNxD038292 - for ; Sun, 13 May 2012 03:22:23 +0200 (CEST) - (envelope-from root@fenrir.codigo23.lab) -Received: (from root@localhost) - by fenrir.codigo23.lab (8.14.5/8.14.5/Submit) id q4D1MNLp038270 - for root; Sun, 13 May 2012 03:22:23 +0200 (CEST) - (envelope-from root) -Date: Sun, 13 May 2012 03:22:23 +0200 (CEST) -From: Charlie Root -Message-Id: <201205130122.q4D1MNLp038270@fenrir.codigo23.lab> -To: root@fenrir.codigo23.lab -Subject: fenrir.codigo23.lab security run output - - -Checking setuid files and devices: - -Checking for uids of 0: -root 0 -toor 0 - -Checking for passwordless accounts: - -Checking login.conf permissions: - -Checking for ports with mismatched checksums: - -fenrir.codigo23.lab kernel log messages: -+++ /tmp/security.94lpgJ1k 2012-05-13 03:22:14.000000000 +0200 -+Accounting disabled -+Accounting enabled -+Accounting disabled -+Accounting enabled - -fenrir.codigo23.lab login failures: - -fenrir.codigo23.lab refused connections: - -Checking for a current audit database: - -Database created: Sat May 12 03:20:04 CEST 2012 - -Checking for packages with security vulnerabilities: - -Affected package: nvidia-driver-285.05.09 -Type of problem: NVIDIA UNIX driver -- access to arbitrary system memory. -Reference: http://portaudit.FreeBSD.org/b91234e7-9a8b-11e1-b666-001636d274f3.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/94c0ac4f-9388-11e1-b242-00262d5ed8ee.html - -Affected package: firefox-8.0,1 -Type of problem: mozilla -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/380e8c56-8e32-11e1-9580-4061862b8c22.html - -Affected package: png-1.4.8 -Type of problem: png -- memory corruption/possible remote code execution. -Reference: http://portaudit.FreeBSD.org/262b92fe-81c8-11e1-8899-001ec9578670.html - -Affected package: freetype2-2.4.7 -Type of problem: freetype -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/462e2d6c-8017-11e1-a571-bcaec565249c.html - -Affected package: mutt-devel-1.5.21_3 -Type of problem: mutt-devel -- failure to check SMTP TLS server certificate. -Reference: http://portaudit.FreeBSD.org/49314321-7fd4-11e1-9582-001b2134ef46.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/057130e6-7f61-11e1-8a43-00262d5ed8ee.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/b8f0a391-7910-11e1-8a43-00262d5ed8ee.html - -Affected package: raptor2-2.0.4_1 -Type of problem: raptor/raptor2 -- XXE in RDF/XML File Interpretation. -Reference: http://portaudit.FreeBSD.org/60f81af3-7690-11e1-9423-00235a5f2c9a.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/330106da-7406-11e1-a1d7-00262d5ed8ee.html - -Affected package: libtasn1-2.11 -Type of problem: libtasn1 -- ASN.1 length decoding vulnerability. -Reference: http://portaudit.FreeBSD.org/2e7e9072-73a0-11e1-a883-001cc0a36e12.html - -Affected package: gnutls-2.12.14 -Type of problem: libtasn1 -- ASN.1 length decoding vulnerability. -Reference: http://portaudit.FreeBSD.org/2e7e9072-73a0-11e1-a883-001cc0a36e12.html - -Affected package: gnutls-2.12.14 -Type of problem: gnutls -- possible overflow/Denial of service vulnerabilities. -Reference: http://portaudit.FreeBSD.org/aecee357-739e-11e1-a883-001cc0a36e12.html - -Affected package: firefox-8.0,1 -Type of problem: mozilla -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/a1050b8b-6db3-11e1-8b37-0011856a6e37.html - -Affected package: portaudit-0.5.17 -Type of problem: portaudit -- auditfile remote code execution. -Reference: http://portaudit.FreeBSD.org/6d329b64-6bbb-11e1-9166-001e4f0fb9b1.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- Errant plug-in load and GPU process memory corruption. -Reference: http://portaudit.FreeBSD.org/ab1f515d-6b69-11e1-8288-00262d5ed8ee.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- cross-site scripting vulnerability. -Reference: http://portaudit.FreeBSD.org/1015e1fe-69ce-11e1-8288-00262d5ed8ee.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/99aef698-66ed-11e1-8288-00262d5ed8ee.html - -Affected package: postgresql-client-8.4.10 -Type of problem: databases/postgresql*-client -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/174b8864-6237-11e1-be18-14dae938ec40.html - -Affected package: libxml2-2.7.8_1 -Type of problem: libxml2 -- heap buffer overflow. -Reference: http://portaudit.FreeBSD.org/57f1a624-6197-11e1-b98c-bcaec565249c.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/2f5ff968-5829-11e1-8288-00262d5ed8ee.html - -Affected package: python24-2.4.5_8 -Type of problem: Python -- DoS via malformed XML-RPC / HTTP POST request. -Reference: http://portaudit.FreeBSD.org/b4f8be9e-56b2-11e1-9fb7-003067b2972c.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/fe1976c2-5317-11e1-9e99-00262d5ed8ee.html - -Affected package: firefox-8.0,1 -Type of problem: mozilla -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/0a9e2b72-4cb7-11e1-9146-14dae9ebcf89.html - -Affected package: sudo-1.8.3_1 -Type of problem: sudo -- format string vulnerability. -Reference: http://portaudit.FreeBSD.org/7c920bb7-4b5f-11e1-9f47-00e0815b8da8.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/33d73d59-4677-11e1-88cd-00262d5ed8ee.html - -Affected package: wireshark-1.6.2 -Type of problem: Wireshark -- Multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/3ebb2dc8-4609-11e1-9f47-00e0815b8da8.html - -Affected package: ffmpeg-0.7.8,1 -Type of problem: ffmpeg -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/ea2ddc49-3e8e-11e1-8095-5404a67eef98.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/1a1aef8e-3894-11e1-8b5c-00262d5ed8ee.html - -Affected package: firefox-8.0,1 -Type of problem: mozilla -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/e3ff776b-2ba6-11e1-93c6-0011856a6e37.html - -Affected package: chromium-15.0.874.121 -Type of problem: chromium -- multiple vulnerabilities. -Reference: http://portaudit.FreeBSD.org/68ac6266-25c3-11e1-b63a-00262d5ed8ee.html - -Affected package: libXfont-1.4.4,1 -Type of problem: libXfont -- possible local privilege escalation. -Reference: http://portaudit.FreeBSD.org/304409c3-c3ef-11e0-8aa5-485d60cb5385.html - -32 problem(s) in your installed packages found. - -You are advised to update or deinstall the affected package(s) immediately. - --- End of security output -- Index: iljam/tools.py =================================================================== --- mailjam/tools.py (revision 22) +++ (revision ) @@ -1,34 +1,0 @@ -# -*- coding: utf-8 -*- - -""" -The mailjam project - tools.py - -This file is released under the BSD license, see LICENSE for -more information. - -Francisco de Borja Lopez Rio - -Soluciones Informaticas Codigo23 S.L.U. - http://codigo23.net -""" - -import re - -def validate_email_address(address): - - """ - This function validates a given address, returning True - if it is a valid address, False otherwise. - - The function uses a regexp from the django project, and - it is inspired in this snippet: - - http://djangosnippets.org/snippets/1093/ - """ - - if not isinstance(address, str) and not isinstance(address, unicode): - return False - - email_re = re.compile( - r"(^[-!#$%&'*+/=?^_`{}|~0-9A-Z]+(\.[-!#$%&'*+/=?^_`{}|~0-9A-Z]+)*" # dot-atom - r'|^"([\001-\010\013\014\016-\037!#-\[\]-\177]|\\[\001-011\013\014\016-\177])*"' # quoted-string - r')@(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+[A-Z]{2,6}\.?$', re.IGNORECASE) # domain - return True if email_re.match(address) else False Index: tup.py =================================================================== --- setup.py (revision 34) +++ (revision ) @@ -1,71 +1,0 @@ -import os -from distutils.core import setup - -# Yes, I'm ommiting windoze... -BSDs = ['FreeBSD', 'OpenBSD', 'NetBSD', 'DragonFlyBSD'] -linux = ['Linux'] -osx = ['Darwin'] - -def proper_etc_path(): - """ - Try to set the proper path for configuration files, depending - on the operating system. - - FIXME: I'm not sure this would work fine, as this will be executed - when running python setup.py sdist, not when installing from the - source package. - """ - os_name = os.uname()[0] - if os_name in BSDs: - return '/usr/local/etc/' - if os_name in linux or os_name in osx: - return '/etc/' - return '' - -def proper_rc_path(): - """ - Similar to proper_etc_path(), returns the path where startup scripts - should be placed - """ - os_name = os.uname()[0] - etc_path = proper_etc_path() - if os_name in 'BSDs': - return etc_path+'rc.d' - if os_name in linux: - return etc_path+'init.d' - if os_name in osx: - # FIXME: not sure about where startup scripts should be placed in - # "stock" osx (no macports, no homebrew, etc) - return etc_path - return '' - -setup( - name='mailjam', - version='0.1.1', - author='Francisco de Borja Lopez Rio', - author_email='borja@codigo23.net', - packages=['mailjam'], - url='https://bitbucket.org/codigo23/mailjam', - download_url='http://pypi.python.org/pypi/mailjam#downloads', - license='BSD licence, see LICENSE', - description='Mailing lists management software', - long_description=open('README').read(), - scripts=['bin/mailjam-server', 'bin/mailjam-mta', 'bin/mailjam-cli'], - data_files=[(proper_etc_path()+'mailjam', ['conf/mailjam.conf', - 'conf/mailjam-mta.conf', - 'conf/mailjam-cli.conf']), - (proper_rc_path(), ['bin/rc.d/mailjam'])], - classifiers=[ - 'Development Status :: 4 - Beta', - 'Environment :: Console', - 'Environment :: No Input/Output (Daemon)', - 'Intended Audience :: System Administrators', - 'License :: OSI Approved :: BSD License', - 'Natural Language :: English', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 2', - 'Topic :: Communications', - 'Topic :: Communications :: Email', - 'Topic :: Communications :: Email :: Mailing List Servers', - ] -) Index: src/config.py =================================================================== --- src/config.py (revision 0) +++ src/config.py (revision 0) @@ -0,0 +1,10 @@ +# -*- coding: utf-8 -*- + +import os + +# The default path for storage files +storage_path = os.path.join(os.path.dirname(__file__), 'db') + +# Set to True to set that, by default, only emails from members +# will go into the list +private_mailing = True Index: src/models.py =================================================================== --- src/models.py (revision 0) +++ src/models.py (revision 0) @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- + +import os +from tools import validate_email_address +from storage import JsonStorage +import config + +class Member(): + + """ + Class that defines a mailing list member + """ + + def __init__(self, address): + self.address = self._validate_address(address) + + def __repr__(self): + return "" % self.address + + def __str__(self): + return self.address + + def _validate_address(self, address): + if not validate_email_address(address): + raise ValueError(address, ' is not a valid email address') + return address + + +class MailingList(): + + """ + Class that defines a mailing list + """ + + def __init__(self, name, address, members={}, config={}, storage=None): + self.name = name + self.address = address + self.members = members + self.config = config + # FIXME: The path to the storage files directory should be defined + # in a configuration file + self.storage = JsonStorage(os.path.join(config.storage_path, + self.address)) + + def __repr__(self): + return "" % self.address + + def __str__(self): + return self.address + + def _validate_config(self): + if not 'storage' in self.config.keys(): + self.config['storage'] = os.path.join(config.storage_path, + self.address) + if not 'archive' in self.config.keys(): + self.config['archive'] = os.path.join(self.config['storage'], + 'archive') + if not 'private' in self.config.keys(): + self.config['private'] = config.private + + def _validate_member_object(self, member): + if not isinstance(member, Member): + raise TypeError(member, ' is not a valid Member instance') + return member + + def _validate_member(self, member): + member = self._validate_member_object(member) + return member.address in self.members_addresses() + + def _validate_member_by_address(self, address): + if not validate_email_address(address): + raise ValueError(address, ' is not a valid email address') + return address in self.members_addresses() + + def members_addresses(self): + return self.members.keys() + + def add_member(self, member): + member = self._validate_member_object(member) + if self._validate_member(member): + return False + self.members[member.address] = member + return True + + def add_member_by_address(self, address): + if self._validate_member_by_address(address): + return False + member = Member(address) + self.members[address] = member + + def delete_member(self, member): + member = self._validate_member_object(member) + if not self._validate_member(member): + return False + del self.members[member.address] + return True + + def load(self): + if self.storage.exists(): + data = self.storage.read() + self.name = data.name + self.address = data.address + self.members = data.members + + def save(self): + self.storage.write(self) Index: src/mta.py =================================================================== --- src/mta.py (revision 0) +++ src/mta.py (revision 0) @@ -0,0 +1,49 @@ +# -*- coding: utf-8 -*- + +import sys, email, smtplib +from datetime import datetime +from models import MailingList +import config + +class Sendmail(): + + def __init__(self, mailing_list): + if not isinstance(mailing_list, MailingList): + raise ValueError(mailing_list, ' is not a valid mailing list') + self.mailing_list = mailing_list + self.suscriptors = self.mailing_list.members_addresses + self.reply_address = self.mailing_list.address + self.queue = [] + self.archive = self.mailing_list.config.get('archive', + config.storage_path) + + def get_raw_email(): + try: + raw_email = sys.stdin.read() + except: + raise IOError('Can not get a valid email from stdin') + return raw_email + + def save_raw_email(): + filename = os.path.join(self.archive, + datetime.today().strftime('%Y%d%m%H%M%S%f')) + tmpfile = file(filename, 'w') + tmpfile.write(raw_email) + tmpfile.close() + self.queue.append(filename) + + def send_email(): + if not self.queue: + raise ValueError('The emails queue is empty') + next_email = self.queue.pop() + email_file = file(next_email, 'r') + email_data = email.message_from_file(email_file) + email_file.close() + + email_data['Reply-to'] = self.reply_address + + smtp_conn = smtplib.SMTP() + smtp_conn.connect() + smtp_conn.sendmail(email_data['From'], self.suscriptors, + email_data.as_string()) + smtp_conn.close() Index: src/storage.py =================================================================== --- src/storage.py (revision 0) +++ src/storage.py (revision 0) @@ -0,0 +1,65 @@ +# -*- coding: utf-8 -*- + +import os, json + +class JsonStorage(): + + """ + Json-based storage. + """ + + def __init__(self, path='storage.json'): + if os.path.isdir(path): + raise IOError(path, ' is a directory, exiting') + self.path = path + + def exists(self): + return os.path.exists(self.path) + + def jsonize(self, obj): + """ + Convert objects to a dictionary of their representation + Based on the exmplaes from Doyg Hellmann: + http://www.doughellmann.com/PyMOTW/json/#working-with-your-own-types + """ + jobj = { '__class__':obj.__class__.__name__, + '__module__':obj.__module__, + } + jobj.update(obj.__dict__) + return jobj + + def dejsonize(self, jobj): + """ + Convert some data that has been "jsonized" to the original + python object. Again, based on the examples from Doug Hellmann + """ + if '__class__' in jobj: + class_name = jobj.pop('__class__') + module_name = jobj.pop('__module__') + module = __import__(module_name) + class_ = getattr(module, class_name) + args = dict((key.encode('ascii'), value) \ + for key, value in jobj.items()) + return class_(**args) + return jobj + + def write(self, data): + with open(self.path, 'w') as storage: + json.dump(data, storage, sort_keys=True, indent=4, + default=self.jsonize) + return True + return False + + def read(self): + with open(self.path, 'r') as storage: + try: + data = json.load(storage,object_hook=self.dejsonize) + except ValueError: + # if no json data could be imported, the file could be + # damaged or perhaps it does not containg json-encoded + # data, simply return an empty string + # + # FIXME: we should notify the user about the problem + return '' + return data + Index: src/tools.py =================================================================== --- src/tools.py (revision 0) +++ src/tools.py (revision 0) @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- + +import re + +def validate_email_address(address): + + """ + This function validates a given address, returning True + if it is a valid address, False otherwise. + + The function uses a regexp from the django project, and + it is inspired in this snippet: + + http://djangosnippets.org/snippets/1093/ + """ + + email_re = re.compile( + r"(^[-!#$%&'*+/=?^_`{}|~0-9A-Z]+(\.[-!#$%&'*+/=?^_`{}|~0-9A-Z]+)*" # dot-atom + r'|^"([\001-\010\013\014\016-\037!#-\[\]-\177]|\\[\001-011\013\014\016-\177])*"' # quoted-string + r')@(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+[A-Z]{2,6}\.?$', re.IGNORECASE) # domain + return True if email_re.match(address) else False