FrontPage  Index  Search  Changes  Atom  PageRank  Login

Hikidashi - Hiki on Rack - private-view Diff

  • Added parts are displayed like this.
  • Deleted parts are displayed like this.

 ページに閲覧制限を掛けて、ログインしていない人からは見られないようにするプラグインです。[[需要|http://hikiwiki.org/its/?Ticket-65]]があるようなので。

 ''Rackブランチではなく、オリジナルのHiki用です(バージョン0.8.8.1で動作確認済み)。''

{{toc_here}}

!! ダウンロード
{{attach_anchor('private-view.tar.gz')}}

!! インストール
 上のファイルをダウンロードして展開し、Hikiのディレクトリーに突っ込んでください。

!! 使い方
 [[ユーザー編集プラグイン|http://hikiwiki.org/ja/edit_user.rb.html]](edit_user.rb)と併せて使う必要があります。ユーザー編集プラグインを有効化し、管理画面で「登録ユーザのみ編集できるように制限しますか?」を「はい」にしておいてください。必要なら(管理者以外にも閲覧させたい人がいるなら)ユーザーを追加してください。

 閲覧制限プラグインを有効化すると管理画面に『閲覧制限』というメニューができます。そこで閲覧制限に使うキーワードを指定します(複数可)。

 次に、閲覧制限を掛けたいページの編集画面を表示してください。そこのキーワード欄に、上で指定した制限用キーワードを記述すると、そのページが制限対象となり、ログインしていないユーザーは見ることができなくなります。

 キーワードの例としては「private」「下書き」といった物が考えられますし、「ウェブマガジン5号」というような物にしておけば、そのウェブマガジン用の記事を何ページもシークレットのまま書き溜めて、ある日このキーワードによる閲覧制限を外すことで一挙公開する、という使い方もあります。

!!! 注意
 このプラグインで閲覧制限を掛けたページは、通常の閲覧では問題なく制限を掛けられますが、ある種のプラグインからは見えてしまいます。ですので、Hikiに同梱の以下のプラグインには閲覧制限対応バージョンを用意しました。

 これらについては、同梱の***_private-view.rb(rss_private-view.rbなど)を有効化し、元のプラグイン(rss.rb)は無効にしてください(有効でも問題なく動くはずですが)。
* category.rb
* google-sitemaps.rb
* incremental_search.rb
* keyword.rb
* orphan.rb
* pagerank.rb
* quote_page.rb
* rank.rb
* recent2.rb
* rss.rb
* sitemap.rb

 また、XML-RPCでの動作は未確認です。

!! メモ
!!! To Do
* 各種プラグインのオルタナティブの提供
** RSS等、添付のプラグインについては、private-view用のオルタナティブプラグインを提供するのがいいだろう。rss-for-private-view.rbみたいな。
** 言語ファイルは、当然rss-for-private-view.rbというファイル名で提供することになるが、中身は単にrss.rbを読み込みだけでいいと思う。
** private-view.rbを使っていない時にも適切に動くようにしたい。private-viewを有効化しているかどうかで、いちいち管理者にrss.rbとrss-for-private-view.rbとを切り替えるような負担は負わせたくない。{{br}}→private-view.rbが有効かどうかで処理を切り分ければよい。無効の時には単にrss.rbを読み込めばよい。
** 現在、必要と思われるプラグインは次の通り。00default.rbとか(recentプラグインとか)は必ず先に読まれるようになっているので、private-view.rbの中からパッチを当てるだけでよい。
*** rss.rb(済)
*** keyword.rb(済)
*** incremental_search.rb(済)
*** sitemap.rb(済)
*** rank.rb(済)
*** quote_page.rb(不要?)(済)
*** recent2.rb
*** pagerank.rb
*** atom.rb(添付ではないが自分が作った物なので)
** RSSプラグインでは、閲覧制限中のページをフィードに含めるかどうかを選べるようにするといいと思う。Atomプラグインも同様。
* 管理画面で、edit_user.rbが無効の時に、有効にしてくださいと警告を出す。ついでに上のオルタナティブプラグインについてもこっちを使ってくださいと言う。→edit_user.rbを有効にするだけでは駄目で、管理画面の「編集の制限」を「はい」にしなくてはならない。
* XML-RPCでの確認、対応
* 制限をかけたページへのリンクの扱いを決める。リンクにするか?をつけるか只のテキストにするか。
** これはどこまで隠すかと言うポリシーの問題。今はなるべく隠しているが、結局URIを直接指定してアクセスされたら、ページの存在はバレる。
** 新規作成からバレることはない、ログインしないと作成できないから。念のため。
** 只のテキストにする。ログインしていない時の、存在しないページへのアンカーと同じ。
*** これはHikiDocにパッチを当てなければならないことを意味する……。

!!! オルタナティブプラグインの作り方
プラグインをprivate-view対応にして、正弦のかかったページが見られないようにする手順。

# プラグインファイルの作成{{br}} もとのプラグインファイル(例:rss.rb)を、拡張子の前に「_private-view」を入れてコピーする(rss_private-view.rb)。
# 閲覧制限プラグインが無効の時の処理を書く{{br}} 場合分けをし、元のプラグインをload_fileで読み込む。
# 言語ファイルの作成{{br}} プラグインと同名のファイルを作る。内容は元のプラグインの言語ファイルを読み込むだけ。{{br}} それを各言語ファイル用のディレクトリーにコピーして回る。
# プラグインの閲覧制限対応{{br}} それぞれのプラグインに合わせて。