OpenPNE 3

原因¶

下記コマンドを実行した時にデイリーニュース用のガジェットが表示可能かのロジックが正しくない．

  $ ./symfony openpne:send-daily-news

lib/task/openpneSendDailyNewsTask.class.php の下記部分が実行され，61 行目が実行される．

 27   protected function execute($arguments = array(), $options = array())
 28   {
...
 56       $filteredGadgets = array();
 57       if ($gadgets)
 58       {
 59         foreach ($gadgets as $gadget)
 60         {
 61           if ($gadget->isEnabled())
 62           {
 63             $filteredGadgets[] = array(
 64               'component' => array('module' => $gadget->getComponentModule(), 'action' => $gadget->getComponentAction()),
 65               'gadget' => $gadget,
 66               'member' => $member,
 67             );
 68           } 
 69         } 
 70       } 

ここで isEnabled() を見てみると，sfContext で得られる getUser() で使えるかどうかを決定している．しかし，タスクで実行しているためここで得られる User は実際にメールを送信したい Member を含む User ではなくタスクを実行した時の User （ここでは apps/api/lib/myUser.class.php ）である．エラー自体はここで User から getMember() を呼び出すことができないという問題であるが，エラーが発生していなくても正しく動作しないものと思われる．

lib/model/doctrine/Gadget.class.php

 66   public function isEnabled()
 67   {
 68     $list = $this->getGadgetConfigList();
 69     if (empty($list[$this->name]))
 70     {
 71       return false;
 72     }
 73 
 74     $controller = sfContext::getInstance()->getController();
 75     if (!$controller->componentExists($this->getComponentModule(), $this->getComponentAction()))
 76     {
 77       return false;
 78     }
 79 
 80     $member = sfContext::getInstance()->getUser()->getMember();
 81     $isEnabled = $this->isAllowed($member, 'view');
 82 
 83     return $isEnabled;
 84   }

修正案¶

1. 修正案1: Gadget の isEnabled() メソッドを用いるのではなく直接 isAllowed() で表示するかどうかを決定する．
   

   diff --git a/lib/task/openpneSendDailyNewsTask.class.php b/lib/task/openpneSendDailyNewsTask.class.php
   index f70f082..890ec4a 100644
   --- a/lib/task/openpneSendDailyNewsTask.class.php
   +++ b/lib/task/openpneSendDailyNewsTask.class.php
   @@ -58,7 +58,7 @@ EOF;
          {
            foreach ($gadgets as $gadget)
            {
   -          if ($gadget->isEnabled())
   +          if ($gadget->isAllowed($member, 'view'))
              {
                $filteredGadgets[] = array(
                  'component' => array('module' => $gadget->getComponentModule(), 'action' => $gadget->getComponentAction()),
   

2. 修正案2: 表示可能かどうかを見たいメンバを Gadgetの isEnable() メソッドの引数に与えるようにする．
   

   diff --git a/lib/model/doctrine/Gadget.class.php b/lib/model/doctrine/Gadget.class.php
   index 4cb5053..80ab1cd 100644
   --- a/lib/model/doctrine/Gadget.class.php
   +++ b/lib/model/doctrine/Gadget.class.php
   @@ -63,7 +63,7 @@ class Gadget extends BaseGadget implements opAccessControlRecordInterface
        return $list[$this->name]['component'][1];
      }
   
   -  public function isEnabled()
   +  public function isEnabled($member = null)
      {
        $list = $this->getGadgetConfigList();
        if (empty($list[$this->name]))
   @@ -77,7 +77,10 @@ class Gadget extends BaseGadget implements opAccessControlRecordInterface
          return false;
        }
   
   -    $member = sfContext::getInstance()->getUser()->getMember();
   +    if (is_null($member))
   +    {
   +      $member = sfContext::getInstance()->getUser()->getMember();
   +    }
        $isEnabled = $this->isAllowed($member, 'view');
   
        return $isEnabled;
   

備考¶

下記 myUser クラスは sfBasicSecurityUser を継承しているが，他のアプリケーションの myUser と同様に OpenPNE 内の User クラスを継承したほうがよいか？

apps/api/lib/myUser.class.php

  1 <?php
  2 
  3 class myUser extends sfBasicSecurityUser
  4 {
  5 }

• 参考

apps/pc_frontend/lib/myUser.class.php

 10 
 11 class myUser extends opSecurityUser
 12 {

apps/pc_backend/lib/myUser.class.php

 10 
 11 class myUser extends opBaseSecurityUser
 12 {

apps/mobile_frontend/lib/myUser.class.php

 10 
 11 class myUser extends opSecurityUser
 12 {

apps/mobile_mail_frontend/lib/myUser.class.php

 10 
 11 class myUser extends sfBasicSecurityUser
 12 {

更新履歴 ec98cc465d39d414bd65435e95f459905936dafa で適用されました。

テスト実施しましたが、気になる点がありましたので確認お願いします。

フリーエリアガジェットを追加した場合、携帯メールアドレス宛てにデイリーニュース送信できるか確認¶

• 試験手順
  1. 管理画面のデイリーニュース（携帯メールアドレス向け）ガジェット設定ページ(/pc_backend.php/design/gadget)で、フリーエリアガジェットを追加する
  2. サーバーの 3.6 ディレクトリにアクセスする
  3. $./symfony openpne:send-daily-news 実行する

• 試験結果
  以下エラーが出て携帯メールアドレス宛てにデイリーニュース送信できない。
  

  PHP Fatal error:  Cannot redeclare class defaultComponents in /home/hoge/sns/36.example.com/apps/mobile_frontend/modules/default/actions/components.class.php on line 50
  

• 修正方針
  フリーエリアガジェットを追加した場合、携帯メールアドレス宛てにデイリーニュース送信できるように修正お願いします。

問題2¶

1. 携帯メールアドレスのみを持つメンバを追加する
2. 携帯デイリーニュースにガジェットを追加する
3. 「symfony openpne:send-daily-news」を実行する
   • 下記エラーが発生する
     

     PHP Fatal error:  Cannot redeclare class defaultComponents in /home/hoge/sns/36.example.com/apps/mobile_frontend/modules/default/actions/components.class.php on line 50
     

原因¶

$gadget->isEnabled() の中の sfContext::getInstance()->getController()->componentExists() でコンポーネントの存在確認される際にロードされるコンポーネントのアプリケーションが実際に送信する際のコンテキストとは別の場合があることが原因であると思われる．そのため，最初に pc_frontend で sfContext::createInstance() が呼び出されているので携帯メールアドレス向けにデイリー・ニュースを送信しようとするとエラーが発生する．直前の sfContext::createInstance() と componentExists() のインスタンスが一致する場合はエラーが発生しないため，PCメールアドレスに送信するときにエラーが発生しない．

1. 最初にpc_frontendがコンテキストで設定される （openpneSendDailyNewsTask.class.php 31行目）
   • componentExists時: 未 送信時: 未
2. componentExists() が呼び出される （openpneSendDailyNewsTask.class.php 61行目）
   • componentExists時: pc_frontend 送信時: 未
3. opBaseMailTask::getContextByEmailAddress() 内で sfContext::createInstance() が呼び出される （openpneSendDailyNewsTask.class.php 72行目）
   • componentExists時: pc_frontend 送信時: pc_frontend
4. opMailSend::sendTemplateMail() が呼び出される （openpneSendDailyNewsTask.class.php 80行目）
   • componentExists時: pc_frontend 送信時: pc_frontend -> メールが送信される
5. opBaseMailTask::getContextByEmailAddress() 内で sfContext::createInstance() が呼び出される （openpneSendDailyNewsTask.class.php 72行目）
   • componentExists時: pc_frontend 送信時: mobile_frontend
6. opMailSend::sendTemplateMail() が呼び出される （openpneSendDailyNewsTask.class.php 80行目）
   • componentExists時: pc_frontend 送信時: mobile_frontend -> エラーが発生する

lib/task/openpneSendDailyNewsTask.class.php

 30 
 31     sfContext::createInstance($this->createConfiguration('pc_frontend', 'prod'), 'pc_frontend');
 32
...
 60         {
 61           if ($gadget->isEnabled($member))
 62           {
...
 71       
 72       $context = $this->getContextByEmailAddress($address);
 73       $params = array(
 74         'member'  => $member,
 75         'gadgets' => $filteredGadgets,
 76         'subject' => $context->getI18N()->__('デイリーニュース'),
 77         'today'   => time(),
 78       );
 79
 80       opMailSend::sendTemplateMail('dailyNews', $address, opConfig::get('admin_mail_address'), $params, $context);

lib/task/opBaseSendMailTask.class.php

 44   protected function getContextByEmailAddress($address)
 45   {
 46     $application = 'pc_frontend';
 47     if (opToolkit::isMobileEmailAddress($address))
 48     {
 49       $application = 'mobile_frontend';
 50     }
 51 
 52     if (!sfContext::hasInstance($application))
 53     {
 54       $context = sfContext::createInstance($this->createConfiguration($application, 'prod'), $application);
 55     }
 56     else
 57     {
 58       $context = sfContext::getInstance($application);
 59     }
 60 
 61     return $context;
 62   }

修正案２¶

コンテキストの変更を 送信時ではなく $gadget->isEnabled() よりも前に行うことで原因で発生するような齟齬が発生しなくなる．

diff --git a/lib/task/openpneSendDailyNewsTask.class.php b/lib/task/openpneSendDailyNewsTask.class.php
index 3a7d9a9..e1c511f 100644
--- a/lib/task/openpneSendDailyNewsTask.class.php
+++ b/lib/task/openpneSendDailyNewsTask.class.php
@@ -48,6 +48,7 @@ EOF;
       }
       $address = $member->getEmailAddress();
       $gadgets = $pcGadgets['dailyNewsContents'];
+      $context = $this->getContextByEmailAddress($address);
       if (opToolkit::isMobileEmailAddress($address))
       {
         $gadgets = $mobileGadgets['mobileDailyNewsContents'];
@@ -69,7 +70,6 @@ EOF;
         }
       }

-      $context = $this->getContextByEmailAddress($address);
       $params = array(
         'member'  => $member,
         'gadgets' => $filteredGadgets,

更新履歴 c9b3144932bb242230d47fd757fc125b7a0551ca で適用されました。

すいません、間違えてステータスを変更しました。

テストOKです。