LOGIN ID Password Auto Login Register Now! Lost Password?
XUGJ Wiki

ModuleManuals

X-update(エックス・アップデート) anchor.png

機能
モジュール・テーマ アップデータ
種別
システム補助
作者
domifara, nao-pon, naao (XoopsX distribution team)
 (TyokyoPenのソースを大いに参考にしています。thx Ryuji, suin)
バージョン
0.21
動作環境
XOOPS Cube Legacy 2.2
配布元
https://github.com/XoopsX/xupdate
複製
非推奨
Page Top

メニュー anchor.png

メインメニューには現れません。

Page Top

概要 anchor.png

 アップデータモジュール「X-update」は、Xoops X (ten)に同梱されるユーティリティ系モジュールです。
 これをXCL (Xoops Cube Legacy) 2.2 以降にインストールすることで、他のモジュールやテーマのインストール、アップデートをFTPクライアントを使わずに迅速に行うことが可能になります。
 X-update導入により、サイト管理者は管理サイトにログインして管理画面のアップデータモジュール操作をブラウザ上で行うだけで、モジュールのgitHubなど配布サイトからのダウンロードからインストールやアップデート、テーマのインストールなどが完了します。 もちろん、d3形式などの複製対応モジュールも、インストールモジュール名(=公開側のフォルダ名称)を変更してインストールすることができます。
 このモジュールを使うメリットは、ユーザー側だけに留まりません。 モジュールやテーマ作者も、常に最新の公開リポジトリからxupdateが取得してくれることと、複数の公開先を持つことによる2重管理の手間からも開放されます。

Page Top

何ができるの? anchor.png

  • FTPクライアントソフトにノータッチで、対応モジュールやテーマをインストールできます。
  • 対応モジュールやテーマの最新版を、xupdateの管理画面操作だけで各公開サーバーからダウンロード取得し、解凍・展開・アップロードまでできますから、その後で通常のモジュールインストール操作を行うだけです。
  • モジュールだけではなく、テーマもストアサイトからダウンロード取得~アップロードまでできます。
Page Top

対応モジュール・テーマ anchor.png

Page Top

動作要件 anchor.png

 X-updateを使うためには、以下の環境が必須となります。

    • PHP 5.2.0 以上
    • PHP cURLエクステンション
    • MySQL 5.0 以上
    • Xoops Cube legacy 2.2.0 以上
Page Top

インストール anchor.png

Page Top

ダウンロード anchor.png

本モジュールを同梱した、XOOPS X (ten) CorePackがありますので、サイトを始めから構築する場合はXOOPS Cube Legacy2.2のインストールから一括して可能なCorePackからの導入をお勧めします。

https://github.com/XoopsX/legacy (CorePack)

Page Top

インストール anchor.png

通常の、xoops_trust_path式の複製対応モジュールと同様です。 但し、次のディレクトリに書き込み(ファイル作成)権限 (777 とか 707 など) が必要です。管理画面で変更した場合には、変更したディレクトリに書き込み権限を与えて下さい。

    • xoops_trust_path/uploads/xupdate
Page Top

アップデート anchor.png

通常通り、モジュール管理よりアップデートします。

Page Top

アンインストール anchor.png

通常通り、モジュール管理よりアンインストールします。
cacheファイルが以下のディレクトリにあるので、削除してください。

    • xoops_trust_path/uploads/xupdate
Page Top

知っておくべき事 anchor.png

X-update では、ユーザーが独自に変更する可能性のある画像や設定ファイルなど、アップデート時は上書きしないようにモジュールごとに設定されていますが、それらのファイル・ディレクトリ以外でアップデート時に上書きされたくないアイテムがある場合は、予め FTP などで書き込み禁止のパーミッション(0404 とか 0444 など)にしておくと、望まない上書きを防止することができます。

予め設定された上書きしないアイテムの例 (xpWiki), X-update_install_only.png
予め設定された上書きしないアイテムの例 (xpWiki)
Page Top

使用方法 anchor.png

全て管理画面で操作します。 次項を参照

Page Top

管理画面 anchor.png

まず、一般設定で FTP関連の設定を全て完了してください。
正しく設定されていない場合、各画面で以下のようにNG判定になります。

check_NG.jpg

正しく設定されれば、下のようにOK判定になります。

check_OK.jpg
Page Top

一般設定 anchor.png

Page Top
圧縮ファイルダウンロード・展開用フォルダ anchor.png

アーカイブをダウンロードして展開するために使用するフォルダ。(xoops_trust_path)配下のディレクトリを指定、最初と最後の"/"(スラッシュ)は含めません。通常は、uploads/xupdate のままでご使用ください。 このフォルダには、707,777 などの書き込み権限を与えてください。

Page Top
使用するFTPライブラリ| anchor.png

サーバーにファイル群をアップロードする際に使用するFTPライブラリの選択。ダイレクトが使えない場合は、カスタムFTP(標準)を選択してください。それでも問題が解決できない場合、 PHP_FTP(FTP over SSL用)や、カスタムSSH_FTPをお試しください。

    • ダイレクト(ファイルオーナーがPHP) サーバー環境によっては、ダイレクトのままで問題無い場合があります。 うまくいかない場合は、以下のFTP関数群を試してください。
    • カスタムFTP(標準) PHPにFTP関数が実装されていない場合は、まずはこのカスタムFTPを選択します。
    • PHP_FTP(FTPS用) PHPにFTP関数が実装されている場合は、こちらも選択できます。 サーバーがFTPSでの転送をサポートする場合は、これを選択して、次項でSSL(FTPS)を設定します。
    • カスタムSSH_FTP サーバーがSSHの使用をサポートしている場合、標準のカスタムFTPよりもこちらの方が高速に動作する場合があります。SSH接続のポート番号が必要です。
    • カスタムSSH2(鍵認証用) サーバーがSSHの鍵認証をサポートしている場合、標準のカスタムFTPよりもこちらの方が高速に動作する場合があります。SSH接続のポート番号と、SSH鍵認証接続場合にprivate_keyが必要です。
Page Top
SSL(FTPS)を使用する anchor.png

前項で「PHP_FTP(FTPS用)」を指定した場合に、SSL(FTPS)が使用可能です。

Page Top
FTPログインID/FTPログインパスワード anchor.png
    • FTPの場合は、ご使用のサーバーの、FTPログインIDとパスワードを入力します。
    • FSSHのパスワード認証の場合も、この欄にSSHログインID、パスワードを入力してください。
    • FSSHの鍵認証の場合は、SSHログインIDのほか、パスワード欄にはSSH鍵認証のprivate_key作成の際に使用したパスフレーズを入力してください。
Page Top
SSH接続のポート anchor.png

SSH_FTP接続、または鍵認証接続の場合にSSHポート番号を指定します。defaultは22。

Page Top
SSH鍵認証接続のprivate_key anchor.png

SSH鍵認証接続場合にprivate_keyが必要です。セキュリティ上、private_keyをサーバーに保存しておくのは危険なので、作業開始前に入力し、作業完了後に消去しておくことを強くお勧めします。

Page Top
.php パーミッション anchor.png

拡張子が php のファイルにセットするパーミッション(PHP が CGI モードの場合など、必要であれば指定します。)

Page Top
デバグ出力を表示する anchor.png

問題が解決しない場合は、ここを「はい」とすることで、追加デバグ情報が表示されます。

Page Top
テーマURL anchor.png

CMS Theme Finder のURLで、通常は変更不要です。

Page Top
 アドオンストアURL anchor.png

通常変更する必要はありません。

Page Top
タグモジュール anchor.png

XCL2.2の共有タグ仕様に準拠したタグモジュール(letag等)を使っている場合は、ここで選択することで各モジュールにタグ付けられた情報を表示できます。

Page Top

ストア一覧 anchor.png

モジュールやテーマを配布する、登録されたストアサイトと、モジュール・テーマの一覧です。 このページのモジュール・テーマ名のリンクからも、当該モジュール・テーマのダンロード操作に入ることが可能です。

Page Top

モジュール anchor.png

ストアからダウンロード・インストール可能なアイテム(モジュール・テーマ)の情報一覧と、操作ボタンなどの画面です。

module_list.jpg
Page Top
推奨度 anchor.png
      • required 必須
      • recommended 推奨
      • normal 通常
Page Top
最新更新日 anchor.png

モジュールの最終インストール(またはアップデート)された日時を表示します。

Page Top
TRUST or モジュール名 anchor.png

モジュール名と、説明分を表示します。
TRUSTモジュールはTRUST側のモジュール名で表示されるのが一般的です。

Page Top
タイプ anchor.png

モジュールのタイプ(TRUSTモジュールか、単一のX2モジュールか、テーマか)を表示します。

Page Top
操作 anchor.png

インストールボタン、またはアップデートボタンです。

    • このボタンを押すと、下の画面に遷移します。
    • 「操作」のアイコンをクリックすると、インストール・またはアップデート画面に移ります。
      install_confirm.jpg
    • 「取得して配置」をクリックすると、アーカイブのダウンロード・展開・サーバーへのFTPでの配置が行われます。
      install_finish.jpg
    • 「インストール」をクリックして、通常のモジュールインストールに進みます。
      install_install.jpg
Page Top
一括操作 anchor.png

チェックを入れて(複数選択可能)、下にスクロールして現れる「一括操作」ボタンで、一括した連続処理(ダウンロード・展開・配置・インストール/アップデート)が実行できます。

Page Top
複製対応モジュールの操作 anchor.png

d3モジュールなど、複製対応モジュールはモジュール名(ディレクトリ名)が変更可能です。

      • まず、「モジュール名」を編集し、「モジュール名編集」ボタンで送信
        dirname_edit.jpg
      • 確認画面で確認し、「アップデート」
        dirname_confirm.jpg
      • 編集が保存されるので、「ダウンロードと配置」に進みます。 元のモジュール名の行が追加されていますので、同様に追加インストールやモジュール名変更操作が可能です。
        dirname_install.jpg
      • 元のモジュール名のままインストールした場合には、 その行のモジュール名を同様の手順で編集・アップデートすることで、 編集後の行と元のモジュール名の行になってくれます。
Page Top

テーマ anchor.png

ストア上に準備されたテーマも、同様に「取得と配置」を行うことができます。
操作手順は、モジュールの場合とほぼ同様ですが、「インストール」という作業はなくなり、「テーマの管理」画面で当該テーマを有効にする操作が代わりに入ります。

Page Top

テーマファインダ anchor.png

CMSテーマファインダー に登録されたテーマから、ダウンロード可能なものを取得して配置することができます。
参考:CMSテーマファインダー

Page Top

ブロック anchor.png

ブロック名説明ブロック複製
X-update Notifyアップデート可能なアイテムがある場合に通知バーを表示するブロック(管理者のみ)複製可
Page Top

テンプレートセット anchor.png

管理画面用テンプレートのみなので、説明は割愛します。

Page Top

イベント通知の種類 anchor.png

ありません。

Page Top

Tips anchor.png

Page Top

俺的モジュール・テーマの取得と配置 anchor.png

ストアにリストされていないモジュール・テーマでも、一定のディレクトリ構成に従っていれば、自分で設定ファイルを書いて配置することで、X-updateでの取得と配置が可能になります。

  • X2モジュールの場合
    (zipパッケージ)/html/modules/module_name/xxxx
  • trustモジュールの場合
    (zipパッケージ)
    • /html/modules/module_name/xxxx
    • /xoops_trust_path/modules/trust_name/xxxx
  • テーマの場合
    (zipパッケージ)/html/themes/xxxx
Page Top
Store設定ファイルの書式 anchor.png

Store設定ファイルには、各モジュール情報を記載した modules.ini への URL を持つストアーを複数指定できます。

以下の書式にて作成した設定ファイルを、xoops_trust_path/settings/xupdate_mystores.ini に保存・FTPでアップロードします。
パッケージ内の、xoops_trust_path/settings/xupdate_mystores.ini.dist にこのファイルがあるので、リネームして編集することでもOKです。
なお、sidは10000以上の整数値とすることでマスタファイルの参照を回避してください。 これ未満の数値だと、マスタファイルに登録されていないためリストに表示されません。

[My1]                 ; Unique Key: It names freely by an alphanumeric characters.
sid = 10000           ; Store ID: It restricts to 10000 or more.
name = "My Store"     ; Store name
contents = "module"   ; module or theme
setting_type = "ini"  ; ini or json
addon_url = "http://" ; modules ini or json URL
Page Top
modules.ini 設定ファイルの書式 anchor.png

書式、設定可能な項目については Format of modules.ini · XoopsX/xupdate Wiki を参考にしてください。

modules.ini は、URLでアクセスできる場所に置く必要があります。

また、modules.ini は、通常の ini 形式のほかに json 形式でも記述することができます。
データ形式を json にする場合は、ストア設定の setting_type に "json" を指定します。
一つのストアー内に ini 形式と json 形式を混在させることはできません。

modules.ini には、 Format of modules.ini を一単位として複数のモジュールを記載することができます。

Page Top
俺的モジュール・テーマの一般公開 anchor.png
  1. 作成した ini ファイルのアイテムを X-update 上で公開したい場合は、作成した ini ファイルの URL を xoopscube.net の X-update マスタに登録すると、承認後に X-update に公開されます。
  2. ini ファイルの登録は、XOOPS X (ten) Distribution Pack のサイトにログイン後 XOOPS X (ten) Distribution Pack - xupdateマスタ 編集 から行なってください。
  3. 入力項目 Title にストア名、Conntents にコンテンツタイプ (Module 又は Theme)、Addon url に ini ファイルの URL を入力してください。
  4. 登録すると自動的に ini ファイルを読み込み、ini に含まれているモジュール又はテーマの一覧が表示されます。一覧が表示されないとか一部のアイテムが表示されない場合は、ini ファイルに不備がある可能性があります。ini の内容をご確認の上 XOOPS X (ten) Distribution Pack - xupdateマスタ list から登録したストアの編集画面を開き、再度送信してください。
  5. 管理者によりアイテムが承認されると X-update で一般公開されます。
Page Top

よくある質問 anchor.png

Page Top

ライセンス anchor.png

GPL

Page Top

関連モジュール anchor.png

モジュール名説明配布先
           

トップ   凍結 差分 バックアップ 複製 名前変更 リロード印刷に適した表示   ページ新規作成 全ページ一覧 単語検索 最新ページの一覧   ヘルプ   最新ページのRSS 1.0 最新ページのRSS 2.0 最新ページのRSS Atom Powered by xpWiki
Counter: 10185, today: 2, yesterday: 2
初版日時: 2012-07-30 (月) 19:38:17
最終更新: 2014-01-13 (月) 22:06:01 (JST) (1315d) by naao
Back to Page Top
MainMenu
Manuals
Search
XOOPS Official & Dev.
XOOPS Communities