About
- Last Update -
2014.08.07a
faCounter について
Ver. 1.0.0 (00001)Index
はじめに
このドキュメントについて
-
- このドキュメントは、開発に当たってのリリースメモを含みます。マニュアルや説明書に当たるものはこれ以外にはありませんので、このドキュメントをご参照の上 faCounter をご利用ください。
主な特徴
-
- faCounter = File Access Counter
- 指定ファイルのアクセス数をカウント累計します。
- 累計は、指定ファイル・年・月・日・時間 毎にそれぞれ確認できます。
- ダウンロードカウンターとしても利用できます。
- アクセスログも合わせて収集できます。
- ログ保存によるメモリ消費を考慮した保存数制限機能が付加されています。
- 管理者設定は、すべてWeb上から行ないます。
- 管理者ログイン機能などにより設定は保護されます。
- 非定期的に管理者セッションは更新されます。(セッションハイジャック対策)
- 設定は、アクセス検知させるファイルのURLを入力する程度の簡単設定です。
- アクセス検知させるファイルへのGETメソッドは継承されます。
- アクセス検知は、クリック動作がトリガーとなります。
- (ダウンロード完了検知ではなくダウンロード開始検知)
- DBは使わない軽量・シンプル・コンパクト設計です。
特記事項
ダウンロードとインストール
ダウンロード
-
- 圧縮ファイルパッケージ (faC_V.V.V_DDDDD.zip) にて配布しています。
- faCounter ダウンロードはこちらから。(90KB程度)
- 最新版：faC_1.0.0_00001.zip >>> DOWNLOAD
パッケージの構成
-
- パッケージ解凍直後の構成は次のようになります。
-
faC_V.V.V_DDDDD/ | |－!!!/ | |－ readme.txt (SJIS) | |－faC/ [707] ← 707または777です。要注意！ |－.htaccess [604] (UTF-8) A ← .htaccess |－faC.php [604] (UTF-8) A ← PHP Main |－faC_fix.inc [604] (UTF-8) A ← PHP Fixations |－faC_fnc.inc [604] (UTF-8) A ← PHP Functions |－faC_lib.inc [604] (UTF-8) A ← PHP Libraries |－index.html [604] (UTF-8) A ← Index HTML | |－css/ [705] | |－faC.css [604] (UTF-8) A ← StyleSheet | |－html/ [705] | |－_403_html.inc [604] (UTF-8) A | |－_404_html.inc [604] (UTF-8) A | |－About_html.inc [604] (UTF-8) A | |－AcsLog_html.inc [604] (UTF-8) A | |－Admin_html.inc [604] (UTF-8) A | |－AdmLog_html.inc [604] (UTF-8) A | |－CntLog_html.inc [604] (UTF-8) A | |－Footer_html.inc [604] (UTF-8) A | |－Header_html.inc [604] (UTF-8) A | |－Login_html.inc [604] (UTF-8) A | |－img/ [705] | |－exc01_bg.gif [604] B ←--- Image | |－exc01_bw.gif [604] B ←--- Image | |－nms04.jpg [604] B ←--- Image | |－js/ [705] |－faC.js [604] (UTF-8) A ←- JS Libraries - - Notice -
- ・/ はディレクトリ、 [ ] はパーミッション、 ( ) は文字コード。
- ・A はアスキー転送、 B はバイナリー転送。
- ・_V.V.V_DDDDD は faCounter のバージョン。
- ・文字コードは UTF-8(CR/LF) ベース。
- ・ディレクトリ名・ファイル名・配置位置は変更禁止。
インストールとセットアップ
-
- ダウンロードした faC_V.V.V_DDDDD.zip を解凍。
- faC/ ディレクトリ以下をまるごとサーバへアップロード。
- パーミッションの変更。
- ブラウザで faC.php にアクセス ---> Login
- Loginにて初期アカウント admin:1234hoge でログイン。
- Adminアカウントのパスワードを変更。
- 以上でインストールとセットアップは完了です。
-
- - Notice -
- ・
初期パスワード 「1234hoge」 は必ず変更してください。 - ・パーミッションは基本的に上記「パッケージの構成」の様に設定しますが、
- ご使用のサーバ環境などにより臨機応変に対応して下さい。
アップデート(バージョンアップ)
-
- faCounter 最新版のアップデート(バージョンアップ)は、同様にダウンロード＞解凍後、faC/ ディレクトリ以下をまるごとサーバへアップロード(上書き)してください。
アンインストール
-
- レジストリなどの設定はありませんので、アップロードした faC/ ディレクトリ以下をまるごと削除するだけです。
faCounter の使い方
クイック設定(基本)
-
下記２点のみのシンプルなものです。
-
アクセス検知させるファイルのURLを指定。
Admin設定＞「アクセスファイルのURL指定」
-
任意のHTMLへ埋め込みリンクタグを設置。
<a href="***/faC/?id=N">***</a>
または、
<a href="***/faC/faC.php?id=N">***</a>
-
ログイン
-
- 管理者のアカウントにてログインします。
- 初期アカウントは admin:1234hoge です。
- ログイン認証に成功すると「Admin(設定)」ページへ進みます。
- faCounter はクッキーを利用しています。ブラウザクッキーは有効にてご利用ください。
Admin設定
-
- ここでは、管理者設定を行ないます。
- Adminアカウントの変更
- ・ユーザ名またはパスワードの変更ができます。
- ・初期パスワード 「1234hoge」 は必ず変更してください。
- アクセスファイルのURL指定
- ・アクセス検知させるファイルのURLを指定します。
- ・URLは http://～ 形式でフルパス指定してください。
- ・既存のURL指定を削除（空欄に）すると、その id に関する過去データはすべて削除されますのでご注意ください。
- ・HTMLへの埋め込みリンクタグ
- 基本的には下記どちらかの書式で設置してください。
- <a href="***/faC/?id=N">***</a>
- <a href="***/faC/faC.php?id=N">***</a>
- また、
- <iframe src="***/faC/?id=N" .... ></iframe>
- などという使い方もできます。
- ・GETメソッドは継承されます。
- 例えば、上記で &abc=123 を追加して、
- <a href="***/faC/?id=N&abc=123">***</a> としたとすると、
- 指定したURLへも ?id=N&abc=123 は継承されます。
- id=N は必ず継承されますので、メソッド追加する際はダブルブッキングに注意してください。
- アクセスログの最大保存行数指定
- ・1ヶ月間/１id に採取するアクセスログの最大保存行数を指定してください。
- ・１アクセスにつき１行のログがファイルに保存されます。
- ・直近のアクセスログがトコロテン方式で指定行数分保存プールされます。
- ・アクセスログの中身は、アクセスしたユーザの情報などです。
- 主なものには、IPアドレス・ホスト名・ユーザエージェントなどがあります。
- ・0 を指定するとその時点からアクセスログは採取されなくなります。
- 但し、今まで採取した過去ログはそのまま残ります。
- ・アクセスが多い場合、あまり大きな行数を指定しているとサーバメモリを多く消費してしまう怖れがありますので、指定数には注意が必要です。例えば、1000 を指定した場合で、1000回以上/月 アクセスがあった時には、１id 当たり約 1000 x 200 = 200KB/月、2.4MB/年 消費する目安です。
- ・この指定はすべての id に共通に適用されます。
- ・デフォルトは 100 行です。
- 入力が完了したら、下方の [設定更新] をクリックして更新を適用します。
カウンタ
-
- カウンタは、ユーザアクセスの累計カウントです。
- 現在までのアクセスカウント状況を id/年/月/日/時間 別にモニタリングします。
- 管理者がログイン状態の時は、管理者のアクセスはカウントされません。
アクセスログ
-
- アクセスログは、ユーザアクセスのログ情報です。
- 現在までのアクセスログ状況を id/年/月 別にモニタリングします。
- 管理者がログイン状態の時は、管理者のアクセスはログ採取されません。
Adminログ
-
- Adminログは、管理者が設定変更などを行なった時のログ情報です。
- 管理者以外が不正アクセスを行なった場合などにもログ保存されます。
- 現在までのAdminログ状況を月別にモニタリングします。
- Adminログの最大保存行数は、200 行/月 固定です。
アバウト
-
- このAboutページです。
完全初期化
-
- 下記を実行して、faCounter をインストール時の初期状態に戻します。
- ・Adminアカウントの初期化 → admin:1234hoge
- ・Admin設定データの初期化
- ・今まで採取したすべてのアクセスデータの削除
- ・セッション関連すべてのクリア
- すべてのデータが初期化されますのでご注意ください。
ログアウト
-
- ログアウトして、ログインページへ戻ります。
- ログイン状態は解除され、管理者ではなくなります。
終了
-
- ログアウトせず、ログインページへ戻ります。
- ログイン状態は保持され、管理者のままです。
その他
-
- エラーログ
- ・スクリプト上のエラー発生時に保存されるログ情報ですが、すべてのエラーを捕らえるわけではありません。
- ・id毎に DATA/id_N/id_N_err.log へ保存されますが、モニタリングは行ないません。確認する場合は、直接このファイルをテキストで開いてください。
- ・エラーログの最大保存行数は、100 行/id 固定です。
- 自動ログアウト
- サーバの設定環境などにより自動ログアウトする場合があります。一旦、自動ログアウトしてしまうと、他のページへ移行しようとしても「Forbidden, Unauthorized Access」となる場合があります。このような場合は、Loginページから再ログインしてください。
- セッションハイジャック対策
- 非定期的に管理者セッションは更新されます。
- これは、セッションの固定化を起因としたセッションハイジャックの脆弱性を極力防止するものです。ログインの度に管理者セッションは、ある条件と確率で更新されますのでご承知置きください。
著作権に関して
-
- 本ソフトウェアの著作権は、tkx 蔵吉 または WebCreateWorks (以下 「当方」 という) が所有し、著作権法によって保護されています。また、当方が制作したスクリプト本体とその技術・ノウハウおよび画像データ・文章・スキンなど(以下「制作物」という)もこれに準じます。
- Copyright (c) 2014- WebCreateWorks
利用規約
-
- 本ソフトウェアは、個人利用の場合は完全フリーでご利用頂けます。
- 商用利用の場合は、事前にお問い合わせ下さい。 >> nms@tkx.jp
- 制作物のソースコードに関して、他言語への移植、改造、改変、複製、譲渡、再配布、逆コンパイルなどもすべてフリーです。
- 但し、著作権表示は必ず明記してください。
- 本ソフトウェアの使用と上記項目3. に於いて発生したあらゆる事象 (損害や不利益・トラブルなど) に対し、当方は一切責任を負わないものとします。自己の責任の下でご利用下さい。
- 本規約は、本ソフトウェアの完全性や利用者の環境に於ける動作などの完全性を保障するものではありません。
サポートに関して
-
- 当方多忙の為、十分なサポートは困難な状況にあります。何卒ご理解願います。
- しかし、とりあえず NMS トップページに「NMS Support BBS」掲示板をご用意してありますのでそちらのご利用をお願い致します。また、その中で質問などへの回答が出来る方はどしどし書き込んであげて下さい。
- また、今後の改良や制作活動の糧として、不具合情報や現在のご使用状況・近況など何でもかまいません、ご報告・ご連絡頂けると幸いです。
- >> nms@tkx.jp
補足
-
- 当方は、このドキュメントを事前の承認無く随時に変更できるものとします。また、その場合、変更した時点で承諾したものとみなします。
更新履歴
-
- 1.0.0 (00001) --2014.08.07a
-
- とりあえずなんとか開発は一段落。
- 0.0.0 (00000) --2014.04.17a
-
- 開発スタート