転送URLサービスCGI

MasanoriSoft 転送URLサービスCGI
ヘルプVersion1.0.4 版

MasanoriSoft転送URLサービスCGIは、
誰もが簡単に転送URLサービスを無料で運営できるCGIです。

1.ライセンス及び使用規約

MasanoriSoft転送URLサービスCGI(以下、本ソフトウェア)の著作権は、
MasanoriSoft(Ohgita Masanori)及び、開発者に存在します。
付属画像(check.gif、hatena.gif)の著作権は、Cool Liberty様に存在します。

本ソフトウェア及び付属文書は、Creative Commons 表示-継承 2.1 日本 Licenseが適用されており、
お客様は、ライセンス及び使用規約に従う限り、本ソフトウェアを、著作者に無断で及び無料で、
商用非商用を問わずに使用、改変、再配布などすることができます。

但し、お客様は、本ソフトウェアを改変して、使用もしくは再配布する際に、
MasanoriSoftの著作権表示を削除することは出来ません。

又、プログラムから出力されるHTML及び、プログラムコードに含まれた、
MasanoriSoftの著作権表示部分を削除/改変することは認められません。
（改変版作成にあたって改変版作成の著作権表示を併記することは許可する）
又、HTMLテンプレートファイルには、MasanoriSoftの著作権表示を代入する変数を記述する必要があり、
その著作権表示が正しく表示されるようにしなければいけません。

又、お客様が、本ソフトウェア又は、それを改変した物を、
有料で販売または再配布する(著作権表示削除サービスなどを含む)場合も、
MasanoriSoftの著作権表示を削除することは許されません。
(著作権表示削除サービスは、現在検討中です。)

本ライセンス及び条件は、本ソフトウェアを改変したものであろうと、永続的に継承する必要があります。

MasanoriSoft、関係者及び、開発者は、
お客様が、本ソフトウェアを使用したことにより、お客様、利用者様及び、第三者様に
何らかの損害が発生した場合、一切の責任をおわないものとします。
又、本ソフトウェアに何らかの障害がある場合も、必ず修正しないといけない責は無いものとします。

ライセンス及び使用規約は、MasanoriSoftより発表される最新版を、常に有効とし、
お客様及び、その他に事前告知することなく、何時でも変更できるものとします。

↑目次へ

2.スタートアップガイド

ここでは、転送URLサービスCGIを、
サーバへアップロードして使用できる状態にするご案内をします。

まず、転送URLサービスCGIをダウンロードし、アーカイブを解凍(展開)します。

次に、setting.cgiを開きます。
ここでは、サービスを始める上で、最小限の設定のみを行います。
もちろん、殆どの設定は、後から何時でも変更できます。
設定項目について詳しくは、設定項目解説の項をご覧ください。
以下、設定項目で、設定値の箇所(編集するところ)は、太字斜体にしてあります。

まず、12行目付近の
$servicename = "Masanori の URL転送サービス";
を、あなたが運営しようと考える、URL転送サービス名称にして下さい。
もし、テスト目的で動作させるだけならそのままでも構いません。

次に、18行目付近の
$adminpw = "1234";
を、適切な管理者パスワードにします。
管理者パスワードを使って、ユーザの転送URLを自由に削除できますから、
第三者に推測されないものにしてください。

次に、22行目付近の
$cgiurl = "http://example.com/";
を、これからCGIをアップロードするディレクトリ(もしくはサーバ)のURLにします。

次に、27行目付近の
$credit = "Powered by yoursite.";
を変更します。Powered by ＊＊＊＊といった感じ。もしくは、
(C)Copyright ＊＊＊＊. all rights reservedといった感じにしてもいいでしょう。
(＊＊＊＊は、個人の場合は氏名やハンドル名、企業の場合は企業名。)

最後に、100行目付近の
$dbfilename = "./accountdb";
を、適当なファイル名にします。必要なければ、そのままでも構いませんが、
セキュリティ的にも変更されることを推奨します。例えば、./users.cgiなど。
拡張子をcgiにすれば、第三者に、データベースを読み取られる危険性を低く出来ます。
(但し、万が一、読み取られても、パスワードなどはハッシュ化され、読み取り不可能ですから安全です。)
基本的に、この設定は、一度サービスを開始した後に変更することが出来ません。

次に、必要なPerlモジュールがサーバーにインストールされているか確認して下さい。
インストールされていなければ、CPAN、PPMなどを使用してインストールして下さい。
必要なPerlモジュールは以下の通りです。

MIME::Base64　CPAN
File::Path　CPAN
Jcode　CPAN
LWP (LWP::UserAgent)　CPAN
HTML::Template　CPAN
DBI　CPAN
DBD::SQLite　CPAN
Digest::SHA1　CPAN

次に、FTPなどで、転送URLサービスCGIの全てのファイルをサーバーへアップロードします。

次に、サーバーのOSがWindows以外の場合は、パーミッションを設定します。

index.cgiは、CGIプログラムファイルです。
gifcat.pl及び、setting.cgiは、CGIデータファイルです。
カウンタ画像ディレクトリ(初期設定：counter_img)は、CGIから書込操作などをする場合があります。
そのほかのファイルは、通常のHTML、画像ファイルなどと同様です。
各サーバー別のパーミッション設定はこちら

最後に、アップロードしたサーバー上の、index.cgiへアクセスします。
以上です。

↑目次へ

3.参考情報

サーバー別パーミッション設定例

以下の情報は、動作させるための参考情報です。
MasanoriSoftは、これらの情報について一切保証しません。
レンタルサーバー会社もしくは、その契約によっては、
サーバのリソースを不特定多数な第三者へ貸与/割当することを
許可していない場合があります。

■さくらインターネット　さくらのレンタルサーバ　スタンダード
Perlパス：/usr/bin/perl (標準のままでOK)
以下、パーミッション変更のみで動作しました。

index.cgi 755
setting.cgi 755
gifcat.pl 755
全てのディレクトリ(フォルダ) 755
そのほかのファイル 644

■ロリポップ！レンタルサーバー
　Perlパス：/usr/bin/perl (標準のままでOK)
　以下、パーミッション変更のみで動作しました。

index.cgi 755
setting.cgi 700
gifcat.pl 700
move_templ.html 604
templ.html 604
全てのディレクトリ(フォルダ) 705
そのほかのファイル 644

■チカッパ！レンタルサーバー
　Perlパス：/usr/bin/perl (標準のままでOK)
　以下、パーミッション変更のみで動作しました。

index.cgi 700
setting.cgi 600
gifcat.pl 600
全てのディレクトリ(フォルダ) 755
そのほかのファイル 644

■ハッスルサーバー
　Perlパス：/usr/bin/perl (標準のままでOK)
　以下、パーミッション変更のみで動作しました。

index.cgi 700
setting.cgi 600
gifcat.pl 600
全てのディレクトリ(フォルダ) 700
そのほかのファイル 604

↑目次へ

4.カウンタ画像について

転送URLサービスCGIでは、管理者が用意したカウンタ画像から
利用者が使用したいカウンタ画像を選択して、
自らの転送ページで使用することが出来ます。

使用できるカウンタ画像の仕様は以下の通りです。

ファイル形式：GIF
アニメーションGIFは不可。
数字ごとに高さが違う画像は不可。

カウンタ画像の追加方法

まず、カウンタ画像フォルダ(初期設定では、counter_img)の中に、カウンタ画像名のフォルダを作成します。

フォルダ名が、カウンタ画像名として認識されます。カウンタ画像名は、任意で決めます。
通常は、半角英数字と一部の記号のみですが、OS及びその言語又は、ファイルシステムによっては日本語も使用できます。

次に、今作成したカウンタ画像名のフォルダ(以下、同フォルダ)へ、
0.gifから9.gifまでの各数字ごとのGIF画像を入れます。

又、左辺、右辺の画像がある場合は、それぞれ、l.gif、r.gifというファイル名で、同フォルダへ入れると自動認識されます。

又、info.txtというファイル名のテキストファイルを作成し、同フォルダへ入れておくと、
その内容が、カウンタ画像一覧で表示されます。
主に、画像の著作権表示などを記述しておくと良いでしょう。

カウンタ画像を削除するとき

カウンタ画像を削除するときは、各カウンタ画像名のフォルダごと削除するだけです。
もし、そのカウンタ画像を使用している利用者がいた場合は、
自動的に、他のカウンタ画像へ切り替わります。

↑目次へ

5.HTMLテンプレートについて

転送URLサービスCGIでは、サービス画面、転送画面などに、
HTMLテンプレート(雛形)を使用しています。
HTMLテンプレートは、通常のHTMLファイルと然程変わりません。
基本的には、CGIと同フォルダへアップロードしておきます。
とてもシンプルなサンプルとして、
サービス画面(新規登録/削除/一覧等の画面)用のテンプレートとして、templ.html。
転送画面用のテンプレートとして、move_templ.htmlが添付されています。
それらを編集するか、それらを参考にして他のHTMLに移植して使用できます。
使用するHTMLテンプレートファイル名は、設定ファイルで指定します。

HTMLテンプレートの仕組み

転送URLサービスCGIのHTMLテンプレートの仕組みは、
他とは違い、とてもとてもシンプルで、簡単です。
（その代わり、あまり、細かいカスタマイズは出来ないのですが。）

変数という文字列を、HTML内に記述しておけば、
変数が、文字列に置換えされます。

例えば、<TMPL_VAR NAME=TITLE>という変数を、記述すれば、
新規登録 - ＊＊＊のURL転送といった文字列に置換えされます。
ですから、<TMPL_VAR NAME=TITLE>の場合は、
HTMLの<TITLE></TITLE>タグ内に記述して使います。。

サービス画面用テンプレート変数一覧

以下は、サービス画面用テンプレートに記述する必要がある又、記述できる変数です。
それぞれ必ず一つは記述しなければいけません。

<TMPL_VAR NAME=TITLE>
ページタイトルに置換されます。<TITLE></TITLE>タグなどで使用するといいでしょう。
置換内容には、サービス名称なども含まれます。
置換される例：　新規登録 - ＊＊＊のURL転送サービス
<TMPL_VAR NAME=MODE>
サブタイトルに置換されます。例えば、<h2>タグなど見出しで使用するといいでしょう。
置換される例：　新規登録
<TMPL_VAR NAME=BODY>
本文に置換されます。
<TMPL_VAR NAME=CREDIT>
運営者表示に置換されます。
置換される例：　Powered by ＊＊＊＊
<TMPL_VAR NAME=COPY>
CGIの著作権表示に置換されます。
置換される例： System by MasanoriSoft.

転送画面用テンプレート　変数一覧

以下は、転送画面用テンプレートに記述する必要がある又、記述できる変数です。
それぞれ必ず一つは記述しなければいけません。

<TMPL_VAR NAME=PAGETITLE>
転送先ページのタイトルに置換されます。
<TMPL_VAR NAME=TITLE>
サービス名称に置換されます。
先ほどの、<TMPL_VAR NAME=PAGETITLE>と一緒に、
<TITLE><TMPL_VAR NAME=PAGETITLE> - <TMPL_VAR NAME=TITLE></TITLE>
のように使用されるといいでしょう。
<TMPL_VAR NAME=CACHETAG>
キャッシュ制御タグに置換されます。
(現バージョンでは非実装ですが、一応、記述しておいてください。)
HEAD内を推奨。
<TMPL_VAR NAME=JUMPTAG>
自動転送に必要なMETAリダイレクトタグに置換されます。
HEAD内を推奨。
<TMPL_VAR NAME=SEC>
自動的に移動する、秒数を表示します。
JavaScriptによってカウントダウンされます。
実際に表示されるのは、秒のみですから、
　　約<TMPL_VAR NAME=SEC>秒後に移動します...
のように使用されることを推奨します。
<TMPL_VAR NAME=LINK>
自動的に移動しない場合などの為の、転送先へのリンクタグに置換されます。
置換される例：　<a href ="＊＊＊">自動的に移動しない場合はこちらをクリックします</a>
<TMPL_VAR NAME=COUNTER>
カウンタ画像タグ(カウントするためのタグにもなります)に置換されます。
<TMPL_VAR NAME=CREDIT>
運営者表示に置換されます。
置換される例：　Powered by ＊＊＊＊
<TMPL_VAR NAME=COPY>
CGIの著作権表示に置換されます。
置換される例： System by MasanoriSoft.

↑目次へ

6.設定項目解説

設定ファイル(初期設定では、setting.cgi)をテキストエディタなどで編集すれば、
転送URLサービスの設定を変更できます。

以下、設定項目についての解説です。
設定項目のうち、変更してよい箇所は太字斜体になっています。
いずれも、初期設定が記載されています。

サービスの新規登録可否の切り替え
$newreg = '1';
1＝新規登録を許可する
0＝新規登録を拒否する
全ての方からの新規登録に有効です。
例えば、一時的に、新規登録を休止したい場合などにも使えます。
サービス名
$servicename = "MasanoriのURL転送サービス";
サービス名称の設定です。運営したい任意のサービス名称にします。
＊＊＊URL転送サービスのような名前にすれば、分かりやすいかもしれません。
トップページのURL
$toppage = "./index.cgi";
トップページのURLの設定です。
http://＊＊＊のようなURLでも、../＊＊＊のようなURLでも構いません。
通常は、初期設定で構いませんが、例えば、独自にHTMLでトップページを作ったような場合には
そちらのURLを指定されると良いです。
管理者のパスワード
$adminpw = "1234";
管理者パスワードは非常に大切です。必ず変更して下さい。
この管理者パスワードを使えば、利用者が作成した転送URLを、
何時でも簡単に削除することが出来ます。
CGIを設置したURL
$cgiurl = "http://example.com/";
転送URLサービスCGIを設置したURLに変更しておいてください。
URLの最後の/は必要です。
管理者ページへのリンクを表示するか
$showadminlink = '1';
1＝表示する
0＝表示しない
CGIにアクセスすると表示されるメニューに、
管理者ページへのリンクを表示するか否かの設定です。
いずれに設定しても、管理者ページへアクセスすることは出来ます。
転送URL一覧を表示するか
$showurllist = "1";
1＝表示する
0＝表示しない
1にすれば、CGIにアクセスすると表示されるメニューに、転送URL一覧へのリンクを表示し、
転送URL一覧の表示を有効にします。
アクセス数カウンタを使用するか
$accesscount = "1";
1＝使用する
0＝使用しない
1にすれば、転送ページにアクセス数カウンタが表示されるとともに、
アクセス数のカウントが有効になります。
アクセス数カウンタ画像のディレクトリ
$countimgdir = "./counter_img/";
アクセス数カウンター用画像を保管するディレクトリ(フォルダ)のパスを指定します。
通常は、初期設定で問題ありません。
デフォルトのアクセス数カウンタ画像
$defaultimg = "default";
デフォルト(初期値)として使用されるアクセス数カウンタ画像です。
もし、ここで指定したアクセス数カウンタ画像がなければ
他のアクセス数カウンタ画像が、代用されます。
転送方式の選択
$usejumptype = "1";
1＝両方使用可能
2＝フレーム転送のみ可能
3＝メタタグ転送のみ可能
フレーム転送の場合、転送後もURLは、転送URLのままです。
メタタグ転送の場合、転送後のURLは、転送先URLになります。
通常は、1(両方使用可能)にすることを推奨します。その場合、利用者が選択できるようになります。
転送ページから転送する最低秒数
$minimumsec = '2';
転送ページから自動的に移動するまでの秒数は、利用者が選択できますが、
その最低値を制限することが出来ます。制限しない場合は、0にしてください。
転送ページに広告を掲載した場合に、利用者が移動秒数を0にすると、
広告が殆ど見えない間に移動されてしまうのを防ぐための機能です。
転送ページから転送する秒数の初期値
$defaultsec = '1';
移動するまでの秒数の初期値を設定できます。
但し、実際の初期値は、　最低秒数＋ここで設定する初期値　となります。
ですから、最低秒数が1で、初期値を1に設定すると、実際の初期値は、2秒になります。
サービス画面用テンプレートファイルのパス
$templatefile = "./templ.html";
サービス画面用HTMLテンプレートファイルのパスを設定します。
転送画面用テンプレートファイルのパス
$jtemplatefile = "./move_templ.html";
転送画面用HTMLテンプレートファイルのパスを設定します。
FormのMethodの選択
$methodtype = "1";
1＝POST
2＝GET
通常は、1(POST)を推奨します。何らかの理由で、GETしか使用できない場合には、2にします。
転送URL新規作成時に、管理者へ通知メールを送信するか
$mailadminsend = '0';
0＝送信しない
1＝送信する
管理者への通知メールを送信するには、サーバーでSendmailが使えることと、Sendmailの設定が必要です。
Sendmailのパス　(管理者への通知メールを送信する場合のみ)
$sendmail = '/usr/lib/sendmail';
サーバーに設定されているSendmailへのパスを設定します。
(Sendmailパスは、プロバイダ、レンタルサーバ会社などにお問い合わせ下さい。)
通知先メールアドレス　(管理者への通知メールを送信する場合のみ)
$adminmailaddress = 'p@mpnets.net';
通知メールの送信先メールアドレスを設定します。
送信元メールアドレス　(管理者への通知メールを送信する場合のみ)
$frommailaddress = 'm@mpnets.net';
通知メールの送信元メールアドレスを設定します。
アカウントデータベースファイル名
$dbfilename = "./accountdb";
アカウント情報を保管するデータベースファイルのファイル名を指定します。
account.cgiのように、拡張子をcgiとしておけば、第三者に不正アクセスされる危険性が減ります。
但し、不正アクセスされ内容を閲覧されても、個人情報は存在しませんし、
一番重要なパスワードは、ハッシュ化して保管されますから、元のパスワードを推測することは不可能ですのでご安心下さい。
尚、データベースファイルは自動生成されます。
この設定は、一度サービスを開始した後に、設定だけ変更されますと、異常が発生します。
サービスを開始した後に、この設定を変更する場合は、同時に、実際のデータベースファイル名も変更して下さい。

↑目次へ

7.運用説明

管理者ページへのアクセス方法

http://****/index.cgi?mode=admin
上記のURLへアクセスすれば管理者ページが開きます。
管理者ページでは、転送URLの削除、新規登録拒否リストへの登録などが出来ます。

新規登録拒否IP/ホストファイルについて

新規登録拒否IP/ホストファイルは、テキストファイルですから、
テキストエディタで編集が出来ます。
解除するとき、ワイルドカードでIPアドレス又はホストを指定するときなどは、
テキストエディタを使って直接編集して下さい。
1行に一つのIPアドレス又は、ホスト名を入力して、改行を挿入します。
ワイルドカードは、(*、?)が使用可能です。

↑目次へ

8.更新履歴

Version1.0.4

フレーム転送/メタタグ転送を選択可能にした
（以前は、メタタグ転送のみ。）
転送URL新規作成拒否IPアドレス/ホスト機能を実装。
転送URL新規作成時の管理者への通知メール送信機能を実装。
転送URL作成者のIPアドレス/ホストを記録するように変更。
以上によりデータベースのテーブルを一部変更。
以前のバージョンからバージョンアップするには、別途、データベーステーブルを変更する必要有り。
正式版としてHTML形式のヘルプを添付。

Version1.0.3 RC版 - 08/10/12

転送先のタイトル自動取得について、URLが存在しないなどエラーの場合に
エラーである旨を表示するようにしました。

Version1.0.2(βテスト版) - 08/10/11

利用者の方からご指摘をいただいた不具合及び、表示を修正。
管理者機能(管理者による転送URLの削除機能)を搭載。

Version1.0.1(βテスト版) - 08/10/10

Perlモジュール呼び出しを間違えていた為、一部サーバで動作しなかったのを修正

Version1.0.0(βテスト版)

↑目次へ

目次

1.ライセンス及び使用規約

2.スタートアップガイド

3.参考情報

サーバー別パー ミッション設定例

4.カウンタ画像について

カウンタ画像の追加方法

カウンタ画像を削除するとき

5.HTMLテンプレートについて

HTMLテンプレートの仕組み

サービス画面用テンプレート 変数一覧

転送画面用テンプレート 変数一覧

6.設定項目解説

7.運用説明

管理者ページへのアクセス方法

新規登録拒否IP/ホストファイルについて

8.更新履歴

サーバー別パーミッション設定例

サービス画面用テンプレート変数一覧

転送画面用テンプレート　変数一覧