コミュニティモジュール(xsns)説明書

日付: 2008.04.20

文責:(株)ブラテック 開発者

目次


概要

 このモジュール(xsns)は、SNS(ソーシャル ネットワーキング サービス)をXOOPS内で 立ち上げることができるコミュニティモジュールです。使用用途としては、XOOPSの登録ユーザー内で同じ興味を持つユーザ同士が話し合ったり、限定されたメンバー内で何かやりとりがしたい場合などが考えられます。
 これまで自前でSNSサービスを立ち上げる場合、OpenPNEに代表されるSNSエンジンを利用し、サイトを一から構築する必要がありました。 しかし、既にXOOPSで会員制のポータルサイトを構築している方にとって、 上記ソフトウェアを利用し、追加でSNSサービスを立ち上げることは サイトの運営上(複数サイトでのユーザーの登録・管理など)利用しにくい面もありました。
 本モジュールはそういった方々をターゲットとして開発されたものでして、XOOPSで構築済のサイトに対してモジュールの追加インストールを行うだけでSNSを立ち上げることが可能となります。
 本モジュールver1.0正式リリース現在、OpenPNEでもID連係機能(シングルサインオン)があり、 XOOPSのユーザー情報を利用したSNSサイトの立ち上げが可能となっておりますので、 本モジュールはXOOPSでSNS機能を行う際の候補の一つとして考えていただければ幸いです。


主な機能

本モジュールは、以下の特徴を持っています。


動作確認環境


インストール方法

  1. XOOPS_TRUST_PATHの設定

    XOOPS_ROOT_PATH /mainfile.php で XOOPS_TRUST_PATH が定義されていない場合は、以下のように定義してください。

    ○XOOPS2.0系の場合

    mainfile.phpの39行目付近にあるXOOPS_URLの行以下に、以下の1行を追加してください。
    設定するパスは、お使いの環境に合わせて設定してください。

    define('XOOPS_URL', 'http://www.xoops.com/');
    define('XOOPS_TRUST_PATH', '/home/yourhome/xoops_trust_path'); ←追加例

    ○XOOPS2.1系の場合

    mainfile.phpの39行目にあるXOOPS_TRUST_PATHを設定してください。
    設定するパスは、お使いの環境に合わせて設定してください。

    define('XOOPS_TRUST_PATH', '/home/yourhome/xoops_trust_path'); ←設定例

  2. ファイルのアップロード

    ・ html ディレクトリの中身を XOOPS_ROOT_PATH の中へコピー
     ※ モジュールのディレクトリ名 (xsns) は任意の名称に変更できます。(半角15文字以内)
       ただし、インストール後に変更することはできません。

    ・ xoops_trust_path ディレクトリの中身を XOOPS_TRUST_PATH の中へコピー
     ※ こちらのディレクトリ名は変更する必要はありません。

  3. XOOPSへインストール

     管理者メニューのモジュール管理からインストールしてください。

      ※インストール後、本モジュールの管理者メニュー上部に表示されるディレクトリの属性変更を行ってください。
    ○ 参考情報

    変更するディレクトリのパーミッションは以下の通りです。

    html/uploads/xsns [777]
    html/uploads/xsns/thumbnail1 [777]
    html/uploads/xsns/thumbnail2 [777]
    html/uploads/xsns/thumbnail3 [777]


アップデート方法

以下の手順に従ってアップデートを行ってください。
公開サイトでアップデートを行う際は、サイトをメンテナンス中にするか、モジュールを非アクティブにしてから行ってください。


・1.1.0 から 1.1.1 へアップデートする場合

  1. ファイルをアップロード

    配布アーカイブ内のxoops_trust_pathディレクトリを XOOPS_TRUST_PATH へ上書きアップロードしてください。

  2. モジュールのアップデート

    管理者メニューのモジュール管理から、xsnsモジュールのアップデートを行ってください。


・1.0.x から 1.1.0, 1.1.1 へアップデートする場合

※ 以下の手順は、アップデートにより使用されなくなるファイルを削除するための措置です。セキュリティのために必ず行ってください。

※ また、1.1.0以降ではテンプレートの仕様が大幅に変更されています。
  過去のバージョンのテンプレートを書き換えてご利用されていた方は、お手数ですが再度テンプレートを作り直してください。

  1. 以前のバージョンのファイルを削除

    XOOPS_ROOT_PATH /modules/xsns
    XOOPS_TRUST_PATH /modules/xsns

    の中のファイルを削除してください。

    ※ モジュールをアンインストールする必要はありません。
    ※ アップロードした画像/ファイルが上記のディレクトリ内にある場合は、削除する前に必ずバックアップを行ってください。

  2. ファイルをアップロード

    配布アーカイブ内のファイルを、通常のインストール方法と同様にアップロードしてください。

  3. モジュールのアップデート

    管理者メニューのモジュール管理から、xsnsモジュールのアップデートを行ってください。


アンインストール方法

管理者メニューのモジュール管理からアンインストールしてください。

※ 作成したコミュニティ、トピックなどのデータは全て削除されますので、必要な場合はバックアップを行ってください。


初期設定

 「管理者メニュー」 → 「コミュニティ」 → 「一般設定」 で各種設定を行います。必要に応じて変更してください。

バージョン情報


使用条件

本モジュールのライセンスは、XOOPSのライセンス(GPL)に従います。
本モジュールの改変・再配布等については、GPLに従って行ってください。


謝辞

本モジュールを作成するにあたり、画面のレイアウト、機能等は、(株)mixi様のmixi,(株)手嶋屋様のOpenPNEに多大な影響を受けておりますので、この場を借りて厚く御礼申し上げます。
また本モジュールは、PSX(Portal Site Xoops)〜九工大生のための学内ポータルサイト〜を弊社が立ち上げる際に開発されたものですので、開発の機会を与えてくださった方々に厚く御礼申し上げます。


respopup.js(一部改変) aki 様
コメントのポップアップ表示部に使用しております。
p2 - PHPでつくった2ch Viewer
ライセンス:MIT license

D3モジュール作成 G.I.JOE 様
D3モジュールを作成するに当たり、picoなど参考にさせていただいております。
PEAK XOOPS - Support&Experiment
ライセンス:GPL

icon famfamfam Mark James 様
ファイル添付時のアイコンとして使用しております。
famfamfam.com: Home
ライセンス:Creative Commons Attribution 2.5 License


連絡先


目次へ