source: branches/version-2_13-dev/data/class/pages/LC_Page_Sitemap.php @ 22960

Revision 22960, 10.7 KB checked in by Seasoft, 9 years ago (diff)

#2043 (typo修正・ソース整形・ソースコメントの改善 for 2.13.0)

  • 語句統一「全て」
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2013 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24require_once CLASS_EX_REALDIR . 'page_extends/LC_Page_Ex.php';
25
26/**
27 * Sitemapプロトコル ファイル生成モジュール.
28 * PHP versions 4 and 5
29 *
30 * <pre>
31 * このモジュールは Sitemapプロトコルに対応した XMLファイルを出力する.
32 * EC-CUBE インストールディレクトリの htmlディレクトリへ配置することにより動作する.
33 *
34 * このモジュールにより, 以下のページのサイトマップが生成される.
35 * 1. $staticURL で指定したページ
36 * 2. 管理画面のデザイン管理から生成したページ
37 * 3. 公開されている全ての商品一覧ページ
38 * 4. 公開されている全ての商品詳細ページ
39 *
40 * このモジュールを設置後, 各検索エンジンにサイトマップを登録することにより, 検索エンジンの
41 * インデックス化が促進される.
42 * </pre>
43 * @see https://www.google.com/webmasters/tools/siteoverview?hl=ja
44 * @see https://siteexplorer.search.yahoo.com/mysites
45 *
46 * @author Kentaro Ohkouchi
47 * @version $Id:sitemap.php 15532 2007-08-31 14:39:46Z nanasess
48 *
49 * :TODO: 各ページの changefreq や priority を指定できるようにする
50 * :TODO: filemtime 関数を使えば、静的なページの更新時間も取得できそう
51 */
52class LC_Page_Sitemap extends LC_Page_Ex
53{
54    /** 動的に生成しないページの配列 */
55    var $staticURL;
56
57    /** ページリスト */
58    var $arrPageList;
59
60    /**
61     * Page を初期化する.
62     *
63     * @return void
64     */
65    function init()
66    {
67        parent::init();
68
69        $this->staticURL = array();
70
71        $this->staticURL[] = HTTP_URL . 'rss/' . DIR_INDEX_PATH;
72    }
73
74    /**
75     * Page のプロセス.
76     *
77     * @return void
78     */
79    function process()
80    {
81        // ページのデータを取得
82        // FIXME PCサイトのみに限定している。ある程度妥当だとは思うが、よりベターな方法はないだろうか。
83        $this->arrPageList = $this->getPageData('device_type_id = ?', DEVICE_TYPE_PC);
84
85        //キャッシュしない(念のため)
86        header('Paragrama: no-cache');
87
88        //XMLテキスト
89        header('Content-type: application/xml; charset=utf-8');
90
91        // 必ず UTF-8 として出力
92        mb_http_output('UTF-8');
93        ob_start('mb_output_handler');
94
95        echo '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
96        echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . "\n";
97
98        // TOPページを処理
99        $arrTopPagesList = $this->getTopPage($this->arrPageList);
100        $this->createSitemap($arrTopPagesList[0]['url'],
101                             $this->date2W3CDatetime($arrTopPagesList[0]['update_date']),
102                             'daily', 1.0);
103
104        // 静的なページを処理
105        foreach ($this->staticURL as $url) {
106            $this->createSitemap($url, '', 'daily', 1.0);
107        }
108
109        // 編集可能ページを処理
110        $arrEditablePagesList = $this->getEditablePage($this->arrPageList);
111        foreach ($arrEditablePagesList as $arrEditablePage) {
112            $this->createSitemap($arrEditablePage['url'],
113                                 $this->date2W3CDatetime($arrEditablePage['update_date']));
114        }
115
116        // 商品一覧ページを処理
117        $arrProductPagesList = $this->getAllProducts();
118        foreach ($arrProductPagesList as $arrProductPage) {
119            $this->createSitemap($arrProductPage['url'], '', 'daily');
120        }
121
122        // 商品詳細ページを処理
123        $arrDetailPagesList = $this->getAllDetail();
124        foreach ($arrDetailPagesList as $arrDetailPage) {
125            $this->createSitemap($arrDetailPage['url'],
126                                 $this->date2W3CDatetime($arrDetailPage['update_date']));
127        }
128
129        echo '</urlset>' . "\n";
130    }
131
132    /**
133     * Sitemap の <url /> を生成する.
134     *
135     * @param string $loc ページの URL ※必須
136     * @param string $lastmod ファイルの最終更新日 YYYY-MM-DD or W3C Datetime 形式
137     * @param string $changefreq ページの更新頻度
138     * @param double $priority URL の優先度
139     * @return Sitemap 形式の <url />
140     * @see https://www.google.com/webmasters/tools/docs/ja/protocol.html#xmlTagDefinitions
141     * TODO Smarty に移行すべき?
142     */
143    function createSitemap($loc, $lastmod = '', $changefreq = '', $priority = '')
144    {
145        printf("\t<url>\n");
146        printf("\t\t<loc>%s</loc>\n", htmlentities($loc, ENT_QUOTES, 'UTF-8'));
147        if (!empty($lastmod)) {
148            printf("\t\t<lastmod>%s</lastmod>\n", $lastmod);
149        }
150        if (!empty($changefreq)) {
151            printf("\t\t<changefreq>%s</changefreq>\n", $changefreq);
152        }
153        if (!empty($priority)) {
154            printf("\t\t<priority>%01.1f</priority>\n", $priority);
155        }
156        printf("\t</url>\n");
157    }
158
159    /**
160     * TOPページの情報を取得する.
161     *
162     * @param array $arrPageList 全てのページ情報の配列
163     * @return array TOPページの情報
164     */
165    function getTopPage($arrPageList)
166    {
167        $arrRet = array();
168        foreach ($arrPageList as $arrPage) {
169            if ($arrPage['page_id'] == '1') {
170                $arrRet[0] = $arrPage;
171                return $arrRet;
172            }
173        }
174    }
175
176    /**
177     * 全ての編集可能ページの情報を取得する.
178     *
179     * @param array $arrPageList 全てのページ情報の配列
180     * @return array 編集可能ページ
181     */
182    function getEditablePage($arrPageList)
183    {
184        $arrRet = array();
185        foreach ($arrPageList as $arrPage) {
186            if ($arrPage['page_id'] > 4) {
187                $arrRet[] = $arrPage;
188            }
189        }
190
191        return $arrRet;
192    }
193
194    /**
195     * 全ての商品一覧ページを取得する.
196     *
197     * @return array 検索エンジンからアクセス可能な商品一覧ページの情報
198     */
199    function getAllProducts()
200    {
201        // XXX: 商品登録の無いカテゴリは除外する方が良い気もする
202        $objQuery = SC_Query_Ex::getSingletonInstance();
203        $sql = 'SELECT category_id FROM dtb_category WHERE del_flg = 0';
204        $result = $objQuery->getAll($sql);
205
206        $arrRet = array();
207        foreach ($result as $row) {
208            // :TODO: カテゴリの最終更新日を取得できるようにする
209
210            $arrPage['url'] = HTTP_URL . 'products/list.php?category_id=' . $row['category_id'];
211            $arrRet[] = $arrPage;
212        }
213
214        return $arrRet;
215    }
216
217    /**
218     * 全ての商品詳細ページを取得する.
219     *
220     * @return array 検索エンジンからアクセス可能な商品詳細ページの情報
221     */
222    function getAllDetail()
223    {
224        $objQuery = SC_Query_Ex::getSingletonInstance();
225        $sql = 'SELECT product_id, update_date FROM dtb_products WHERE ' . SC_Product_Ex::getProductDispConditions();
226        $result = $objQuery->getAll($sql);
227
228        $arrRet = array();
229        foreach ($result as $row) {
230            $arrPage['update_date'] = $row['update_date'];
231
232            $arrPage['url'] = HTTP_URL . substr(P_DETAIL_URLPATH, strlen(ROOT_URLPATH)) . $row['product_id'];
233            $arrRet[] = $arrPage;
234        }
235
236        return $arrRet;
237    }
238
239    /**
240     * ブロック情報を取得する.
241     *
242     * @param string $where WHERE句
243     * @param array  $arrVal WHERE句の値を格納した配列
244     * @return array $arrPageList ブロック情報
245     */
246    function getPageData($where = '', $arrVal = '')
247    {
248        $objQuery = SC_Query_Ex::getSingletonInstance();     // DB操作オブジェクト
249        $sql = '';                      // データ取得SQL生成用
250        $arrRet = array();              // データ取得用
251
252        // SQL生成(url と update_date 以外は不要?)
253        $sql .= ' SELECT';
254        $sql .= ' page_id';             // ページID
255        $sql .= ' ,page_name';          // 名称
256        $sql .= ' ,url';                // URL
257        $sql .= ' ,filename';           // ファイル名称
258        $sql .= ' ,header_chk ';        // ヘッダー使用FLG
259        $sql .= ' ,footer_chk ';        // フッター使用FLG
260        $sql .= ' ,author';             // authorタグ
261        $sql .= ' ,description';        // descriptionタグ
262        $sql .= ' ,keyword';            // keywordタグ
263        $sql .= ' ,update_url';         // 更新URL
264        $sql .= ' ,create_date';        // データ作成日
265        $sql .= ' ,update_date';        // データ更新日
266        $sql .= ' FROM ';
267        $sql .= '     dtb_pagelayout';
268
269        // where句の指定があれば追加
270        if ($where != '') {
271            $sql .= ' WHERE ' . $where;
272        }
273
274        $sql .= ' ORDER BY page_id';
275
276        $arrPageList = $objQuery->getAll($sql, $arrVal);
277
278        // URL にプロトコルの記載が無い場合、HTTP_URL を前置する。
279        foreach ($arrPageList as $key => $value) {
280            $arrPage =& $arrPageList[$key];
281            if (!preg_match('|^https?://|i', $arrPage['url'])) {
282                $arrPage['url'] = HTTP_URL . $arrPage['url'];
283            }
284            $arrPage['url'] = preg_replace('|/' . preg_quote(DIR_INDEX_FILE) . '$|', '/' . DIR_INDEX_PATH, $arrPage['url']);
285        }
286        unset($arrPage);
287
288        return $arrPageList;
289    }
290
291    /**
292     * date形式の文字列を W3C Datetime 形式に変換して出力する.
293     *
294     * @param date $date 変換する日付
295     * @return void
296     */
297    function date2W3CDatetime($date)
298    {
299        $arr = array();
300        // 正規表現で文字列を抽出
301        preg_match('/^([0-9]{4})-([0-9]{2})-([0-9]{2}) ([0-9]{2}):([0-9]{2}):([0-9]{2})/', $date, $arr);
302        // :TODO: time zone も取得するべき...
303        return sprintf('%04d-%02d-%02dT%02d:%02d:%02d+09:00',
304                       $arr[1], $arr[2], $arr[3], $arr[4], $arr[5], $arr[6]);
305    }
306}
Note: See TracBrowser for help on using the repository browser.