tml

tml はメーリングリストツールです。Ruby で実装されています。

機能

MLの階層化が可能
ML毎に管理者を設定可能
メールによるリモートからのコマンド実行
正規表現による参加／投稿のメールアドレス制限
MySQLでML情報を管理することが可能
等々…

tml に対する処理がエラーになった場合(非メンバからの投稿や間違ったコマンド等)は、tml がエラーメールを生成するのではなく、tml が異常終了するため、エラーメールの処理は MTA に任されます。

ダウンロード

必要なもの

Ruby 1.8.1以上(これ以下でも動くかも知れません)

ライセンス

本プログラムはRubyライセンスに従います。

メーリングリスト

tmlに関する話題のためのメーリングリストがあります。参加するには、 tml-ctl@tmtm.org 宛に「subscribe」とだけ記述した本文のメールを送ってください。

インストール

# useradd tml
# mkdir /usr/local/tml /var/spool/tml
# chown tml /usr/local/tml /var/spool/tml
# su tml
% tar xvfz tml-X.X.X.tar.gz
% cd tml-X.X.X
% ruby ./install

設定

/usr/local/tml/tml.conf を変更して tml の動作を変更することができます。 tml.conf は Ruby スクリプトです。Ruby の文法に従います。

有効なパラメータは以下の通りです。

項目名	説明	デフォルト値
$tml_dir	TMLディレクトリ	インストール時に指定
$var_dir	TML情報保持ディレクトリ	"/var/spool/tml"
$etc_dir	共通ファイル保持ディレクトリ ("/"で始まっていない場合は$var_dirからの相対パス)	"etc"
$ml_dir	ML情報保持ディレクトリ (〃)	"ml"
$deleted_dir	削除済みML情報ディレクトリ (〃)	"deleted"
$log_file	ログファイル (〃)	"log"
$smtp_server	メール配送サーバ	"localhost"
$smtp_port	メール配送サーバのSMTPポート	"smtp"
$lock_timeout	ロック獲得を待つ時間(秒)	300
$max_lock_time	最大ロック保持時間(秒)	1800
$auto_aliases	ML作成/破棄時に自動的に /var/spool/tml/etc/aliases を更新するかどうか	true
$newaliases	/var/spool/tml/etc/aliases 更新後に実行するコマンド。 postfix の場合は「postalias aliases」コマンドを記述しておけば良いでしょう	nil
$strip_received	Receivedヘッダを削除するかどうか	false
$logging	$log_file にログを記録するかどうか	true
$database	MySQLを使用する場合は "mysql"	nil
$spool_db	スプールをMySQLに持つ場合は "mysql"	$database
以下はML毎に設定可能なパラメータのデフォルト値
$default_not_member	非メンバからの投稿が可能かどうか	false
$default_subject_mlname	サブジェクトにML名を付加するかどうか	true
$default_counter_width	サブジェクトに付加するカウンタの桁数	5
$default_remote_command	メールでのコマンドを許可するかどうか	false
$default_remote_admin	メールでの管理者コマンドを許可するかどうか	false
$default_spool	メールを保存するかどうか	true
$default_need_confirm_command	コマンド実行前に確認メールを送るコマンド一覧	"subscribe,admin"
$default_allowed_command	メールでユーザが実行できるコマンド	"all"
$default_anonymous_command	メールで非メンバが実行できるコマンド	"subscribe,confirm"
$default_admin_command	メールで管理者が実行できるコマンド	"all"
$default_logging	ML毎のログを記録するかどうか	true
$default_replyto_type	Reply-To へッダの付加方法	"ml"
以下は $database="mysql" 時に必要なパラメータ
$mysql_server	MySQLサーバ名	nil
$mysql_user	MySQL接続ユーザ名	nil
$mysql_passwd	MySQL接続パスワード	nil
$mysql_db	MySQLデータベース名	nil

MySQL

MySQLを使用する場合は、tml 用のデータベースを作成し、mysql.sql ファイル中のテーブルを作成し、tml.conf 中に $database, $mysql_server, $mysql_user, $mysql_pass, $mysql_db を設定してください。

例

% mysqladmin -u root -p create tml
% mysql -u root -p -e 'grant all on tml.* to tmluser@localhost identified by "tmlpasswd"'
% mysql -u tmluser -ptmlpasswd tml < mysql.tml
% cat tml.conf
...
$database = "mysql"
$mysql_server = "localhost"
$mysql_user = "tmluser"
$mysql_pass = "tmlpasswd"
$mysql_db = "tml"

MLの管理

tmladmin を使用して ML の管理を行ないます。

% tmladmin cmd

cmd は次のいずれかです。

コマンド	説明
list	MLの一覧を表示します。
create mlname admin	MLを作成します。 admin はMLの管理者メールアドレスです。
drop mlname	MLを破棄します。 MLのデータ $var_dir/mlname は -mlname-yyyymmddhhmmss にリネームされます。
add [--send-mail] mlname addr ...	MLにメールアドレスを追加します。--send-mail オプション指定時は、登録したアドレス宛に welcome メールが送られます。
bye [--send-mail] mlname addr ...	MLからメールアドレスを削除します。--send-mail オプション指定時は、登録したアドレス宛に unsubscribe メールが送られます。
addml mlname child ...	MLの下に子MLを追加します。
byeml mlname child ...	MLの下から子MLを取り除きます。
members mlname	MLのメンバ一覧を出力します。
allmembers mlname	MLのメンバ一覧を出力します。子MLがある場合は子MLのメンバも出力します。
children mlname	MLの子ML一覧を出力します。
parents mlname	MLの親ML一覧を出力します。
admins mlname	MLの管理者アドレス一覧を出力します。
addadmin mlname addr	MLの管理者アドレスを追加します。
byeadmin mlname addr	MLの管理者アドレスを削除します。MLには少なくとも一人の管理者が必要です。
setattr mlname attr=value ...	MLの属性を設定します。
getattr mlname [attr ...]	MLの属性を出力します。属性を指定しない場合は一覧表示します。
setcounter mlname number	MLのカウンタを設定します。
getcounter mlname	MLの現在のカウンタ値を出力します。

setattr,getattr で使用できる属性は次の通りです。

属性名	説明
sender	MLの配信時に使用されるエンベロープ送信者
overview	MLの概要
not_member	メンバ以外からの利用の可否
subject_mlname	SubjectにML名を付加するか否か
counter_width	カウンタの桁数
remote_command	リモートコマンドが有効か否か
remote_admin	リモート管理コマンドが有効か否か
spool	メールをスプールするか否か
need_confirm_command	実行前に確認が必要なコマンド
allowed_command	リモートからユーザが実行できるコマンド
anonymous_command	リモートから非メンバが実行できるコマンド
admin_command	リモートから管理者が実行できるコマンド
logging	ログを記録するか否か
replyto_type	Reply-To へッダの付加方法 "ml":MLアドレス, "admin":管理者アドレス, "from":Fromアドレス, "none":変更しない, それ以外:指定文字列
web_interface	Webインタフェースを使用するか否か(*)

(*)印は現バージョンでは意味がありません。

MLへの配送

MLへの配送は /etc/aliases などに次のようなエントリを作成しておけば良いでしょう。

mlname: "|/usr/local/tml/tml mlname"
mlname-admin: :include:/var/spool/tml/mlname/admin
mlname-ctl: "|/usr/local/tml/tmlctl mlname"

なお、ML作成/破棄時には /var/spool/tml/etc/aliases が自動的に更新されるため、複数の aliases ファイルが参照可能な MTA の場合は、このファイルも指定しておくのが良いでしょう。この場合は、$newaliases パラメータを設定する必要があります。たとえば、Postfix の場合は以下のように指定しておけば良いでしょう。

$newaliases = "/usr/sbin/postalias /var/spool/tml/etc/aliases"

リモートユーザコマンド

コマンドをメール本文に記述し、mlname-ctl 宛に送ることで、MLユーザがコマンドを実行できます。

コマンド	説明
confirm key	コマンド実行の確認
subscribe	MLへの参加
unsubscribe, bye	MLからの退会
members	MLのメンバ一覧
summary args	MLの過去メールサブジェクト一覧
get args	MLの過去メール取り出し
end, exit	コマンドの終了
admin command	管理者コマンドの実行。tmladmin に指定するコマンドと同じです。ただし、list,create,drop,addml,byeml は使用できません。また、setattr で admin_command 属性は設定できません。

アクセス制御

正規表現で参加／投稿メールアドレスを制限することができます。特定のMLに制限を掛けたい場合は、/var/spool/tml/ML名/access というファイルを作成します。このファイルが無い場合は、/var/spool/tml/etc/access があれば、それが参照されます。access ファイルの各行は次の形式で、上から順に評価されます。

正規表現<TAB>アクセス権

アクセス権は次のいずれかです。

アクセス権	説明
permit	参加／投稿許可
permit_post	投稿許可
permit_subscribe	参加許可
reject	参加／投稿拒否
reject_post	投稿拒否
reject_subscribe	参加拒否

どの行にも適合しない場合は permit が適用されます。

テンプレート

登録時の welcome メールや confirm メール等のメッセージは変更することができます。デフォルトのメッセージファイルは /usr/local/tml/templates ディレクトリ配下にあります。ファイルは次のパスの順に検索されます。

/var/spool/tml/ml/mlname/templates/
/var/spool/tml/templates/
/usr/local/tml/templates/

ファイル中の %{...} 部分は次のように置き換えられます。

	パラメータ名	値
共通	mlname	ML名
	adminaddr	管理者アドレス(mlname-admin@domain)
	ctladdr	コントロールアドレス(mlname-ctl@domain)
	from	Fromメールアドレス。通常は sender 属性の値。confirm または admin 時はコントロールアドレス。
	to	Toメールアドレス。このメールを送るきっかけとなったメールの送信者。
admin	command	実行した管理者コマンド
admin	result	実行結果
memberlist	list	MLメンバ一覧
summary	summary	サマリ
archive	msg	アーカイブ(Base64エンコードされている)
confirm	key	確認用キー
confirm	commands	実行を試みているコマンド

TODO

もう少しマシなドキュメントを作る。
Web インタフェースをつける。
w3ml との統合。

履歴

2004-07-29 バージョン 0.5.1

BUG fix: tml.conf 中の $default_XXX が効かない。
BUG fix: tml が生成するメールで Message-Id が重複することがあった。
BUG fix: 未知の charset の Subject が壊れる。

2004-05-08 バージョン 0.5

内部のコードの大幅な変更
MySQL対応
メールアドレス比較時、ローカルパート部は大文字小文字を区別し、ドメイン部は区別しないようにした
$etc_dir, $ml_dir, $deleted_dir, $log_file を $var_dir からの相対パスに変更
インストール方法の変更

2004-03-29 バージョン 0.4.4

BUG fix: tml.rb: allowed_command, anonymous_command, need_confirm_commandが空の時に tmlctl が落ちる
BUG fix: tml.rb: Time#strfimte が "%z" を解釈できない環境で tmlctl が不正な Date へッダを生成する
BUG fix: tml: List-Id の形式がRFC2919になってなかった
メールアドレスの比較時に大文字小文字を区別しないようにした

2004-02-03 バージョン 0.4.3

BUG fix: tml.rb: logging 属性が false でもログが出力されていた
BUG fix: tml.rb: テンプレートの検索パスが誤っていた

2004-01-22 バージョン 0.4.2

BUG fix: test.rb: 本環境の aliases に影響を与えていた
tml, tmlctl: ユーザに通知すべきエラー時に終了コード 100 で終了するようにした
tml: List-* へッダの追加
tml.rb: Date へッダ, Message-Id へッダの追加

2004-01-15 バージョン 0.4.1

BUG fix: install.rb: インストール時に aliases ファイルを初期化していた
BUG fix: tml: 既存のMLを0.4にした時に Reply-To: がつかなくなった

2004-01-14 バージョン 0.4

BUG fix: setup.rb: tmlctl の ruby パスを変更していなかった
tml,tml.rb: replyto_type 属性の追加
tmladmin: add, bye に --send-mail オプションを追加
tmlctl: 「unknown command」エラーを出力しないようにした
setup.rb: 既存の tml.conf の設定を読み込むようにした

2004-01-07 バージョン 0.3.1

member,parents,children ファイルの形式をバイナリ(Marshal)からテキストに変更

2004-01-04 バージョン 0.3

/var/spool/tml配下のディレクトリ構成変更。
spool 機能の追加。
リモートコマンド summary, get 追加。
Subjectがないメールで落ちるバグを修正。
member_list 属性廃止。
allowed_command,need_confirm_command,anonymous_command,admin_command,logging 属性追加。
任意のコマンドに confirm 設定を可能にした。
アクセス制御追加。
ロック機構の変更。
tmladmin admins サブコマンド追加。

2003-11-12 バージョン 0.2

tmladmin create の引数変更。
最低一人のML管理者を必要とするように変更。
ML作成時エイリアスファイルを自動的に作成するようにした。
メールからのコマンドを受け付けるようにした。

2003-11-01 バージョン 0.1

公開

作者

とみたまさひろ

Last modified: Tue Jul 6 02:32:17 JST 2004