アップデート方法

主なアップデート方法は以下の3種類あります。

  • オンラインアップデート
  • 簡単アップデート （手動）
  • 手動アップデート

また、各アップデート時にはテンプレート修正が必要なバージョンがありますので、アップデート時には対象のバージョンだった場合ご対応の上、アップデートをお願いいたします。

オンラインアップデート

オンラインアップデートは管理画面からマイナーバージョンと、パッチバージョンのアップデートする方法です。Ver. 2.8.0 から利用可能です。
バックアップを取ったのちアップデートを行いますので安心して利用できます。特に意図がない場合は、オンラインアップデートの利用を推奨します。

更新されるファイル

アップデートを実行すると、a-blog cms の以下のファイル・ディレクトリが置き換わります。

  • acms.js
  • index.php
  • js
  • lang
  • php
  • private/config.sytem.default.yaml
  • themes/system

オプション

管理画面 > コンフィグ > 機能設定 の 「オンラインアップデート」にオプションがあります

  • パッチバージョンのみ（デフォルト）
  • マイナーバージョンも含める
  • 更新メニューを非表示

デフォルトのパッチバージョンのみ

不具合修正のバージョンのみアップデートを行います。仕様変更などは含まれませんので、安心してアップデートできます。

マイナーバージョンも含める

Ver. 2.8 から Ver. 2.9 へのアップデートのようにマイナーバージョンアップの更新も出来るようになります。

更新メニューを非表示

管理メニューに更新メニューを出さないようにします。お客様に引き渡す時に、あまり触ってほしくない場合などに便利です。

デフォルトのパッチバージョンのみ パッチバージョン（=不具合修正のバージョン）のみアップデートを行います。パッチバージョンには仕様変更が行われたバージョンは含まれませんので、安心してアップデートできます。
マイナーバージョンも含める たとえば Ver.2.8 から Ver.2.9 へのアップデートのようにマイナーバージョンアップの更新も出来るようになります。マイナーバージョンアップには仕様変更が行われたバージョンも含まれます。
更新メニューを非表示 管理メニューに更新メニューを出さないようにします。例えば、納品後に更新者にアップデートしてほしくない場合などに便利です。

アップデートで更新しないファイルを指定する

カスタマイズする中でどうしても、a-blog cms のコアファイルをカスタマイズしてしまう場合があります。 この状態でアップデートを行なってしまうと、新バージョンのファイルで上書きされてしまい、カスタマイズした箇所が戻ってしまいます。

このような場合、private/config.system.yaml に更新しないファイルを指定することにより、アップデートによる上書きを回避できます。

system_update_ignore: [] # アップデートしないファイルを配列で指定 例: [js/config.js] カンマ区切りで指定

例）「js/config.js」と「php/ACMS/POST.php」をカスタマイズしている場合

system_update_ignore: [js/config.js,php/ACMS/POST.php]

新しいバージョンで上書きされなくなりますので、カスタマイズ内容によっては新しいバージョンと整合性が取れず、不具合がでてしまう危険性があります。
コアファイルのカスタマイズは、この危険性を理解のうえ行なってください。

テンプレート修正が必要なバージョンとライセンス

テーマ内にあるテンプレートファイルについては自動変更されません。以下のドキュメントを参考にテンプレートファイルの修正をお願いします。

バージョンごとのアップデート方法

ライセンス別のアップデート方法

Ver.3.0以上へのアップデート

Ver.3.0以上へのアップデートする際に気をつけることは下記の4点です。

  • 簡単アップデートを使用する
  • 事前に新しいライセンスファイルを用意する
  • データベースのアップデートを実行する
  • すでに「api」が使われている箇所があれば変更する

簡単アップデートを使用する

Ver.3.0はメジャーバージョンです。Ver.3.0よりも低いバージョンからアップデートする時はメジャーバージョンアップをすることになります。
オンラインアップデートでは、マイナーバージョンとパッチバージョンのみに対応しているため、今回は対象外となるため利用できません。
より簡単に手動アップデートを行う方法として、「簡単アップデート」を用意しています。

詳しくは以下のドキュメントをご覧ください

事前に新しいライセンスファイルを用意する

Ver.3.0以上では、プログラムの暗号化が廃止され ionCube Loader が必要なくなりました。この変更によりライセンスファイルの内容もアップデートされ、正しく動作するには新しいライセンスファイルの適用が必要になります。
正しいライセンスファイルを適用しないと予期せぬ表示を起こすことがありますので、差し替える時間を短縮するためにアップデート作業時には事前にマイページよりダウンロードすることを推奨いたします。

ライセンスファイルをダウンロードする方法

  1. マイページにログインする
  2. 「所有ライセンス」のページへ移動する
  3. 該当するライセンスをさがし、「ライセンスDL」項目の「Ver.3.0以上」を選んでライセンスファイルをダウンロードする

「ライセンスDL」項目の「Ver.3.0以上」を選択してください

データベースのアップデートを実行する

データベースに変更があるため、データベースのアップデートを実行する必要があります。
1.テンプレートファイルのアップデート後、メンテナンスメニュー（http://ドメイン/〇〇（setupフォルダをリネームしたもの）/index.php）にアクセスしてください。アクセスするためにはログイン情報が必要です。 2.メンテナンスメニューにアクセスしたら、アップデートを実行するために「アップデート実行画面へ」のリンクをクリックします。

3.進んでいくと、削除するテーブルを聞かれますが削除するかは任意で構いません。バックアップをとっておきたい場合は選択せず、アップデートを完了してください。

4.完了画面が現れたら、setupフォルダをリネームします。

すでに「api」が使われている箇所があれば変更する

API機能が新しく追加されたことにより、「api」が予約語に登録されました。
制作したサイトでテーマフォルダ内に同じ名前のディレクトリやカテゴリコードに指定していると思わぬ不具合につながりますので、リネームまたはconfig.server.phpのAPI_SEGMENTの値を「api」以外のものを指定してください。
※API_SEGMENTを「api」以外のものを指定すると、API機能を使う際に「api」と指定していたものはAPI_SEGMENTで指定した値に差し替えてご使用いただくことになります。

config.server.phpのAPI_SEGMENTの設定は以下のコードになります。 define('API_SEGMENT', 'api');

アップデート完了後の確認

アップデート完了後は、念のためバージョンが正常に上がっているかダッシュボードで確認しましょう。

Cookieの使用目的

a-blog cms が使用するデフォルトの Cookie をリストアップし、それらが何のために使用されるのかについて説明します。

＊ ここでは、Ver. 3.0 系の a-blog cms をもとに解説しております。

PHPセッション

a-blog cms では PHPセッションに依存して、Web リクエストにまたがるセッションを維持します。
このCookieの名前は、デフォルトだと 「sid」 と名前になります。ただし、config.server.phpで名前を変更することもできます。

define('SESSION_NAME', 'sid');

PHPセッションは、以下のような機能について利用されます。

ログイン維持

ログインした時に、ページを移動してもログイン状態にできるように、PHPセッションを利用しています。

CSRF

フォームなどの POSTリクエスト の CSRF（クロス・サイト・リクエスト・フォージェリ） 対策のためにPHPセッションを利用しています。

カート機能

カート機能で、カート内の商品内容維持のため、PHPセッションを利用しています。

SNSログイン認証

SNS認証時に、一時的に値を保持するため、PHPセッションを利用しています。

ダイレクト編集

エントリーを直接編集できる「ダイレクト編集」機能のON/OFF状態維持のため、　「acms_config_entry_edit_inplace_enable[0]」 という名前のCookieを使用しています。

a-blog cms と GDPR について

GDPRの観点から、a-blog cms のデフォルトCookieは個人情報や機密情報を収集しないようにしております。 また保存された情報は、開発元の有限会社アップルップルや第三者に送信されることはありません。

a-blog cms のデフォルトCookieは、ユーザー認証、セキュリティ、および基本的なウェブアプリケーション操作の目的のみに使用されます。