ConcurrencyController.php
1 <?php
2 /**
3  * wCMF - wemove Content Management Framework
4  * Copyright (C) 2005-2020 wemove digital solutions GmbH
5  *
6  * Licensed under the terms of the MIT License.
7  *
8  * See the LICENSE file distributed with this work for
9  * additional information.
10  */
11 namespace wcmf\application\controller;
12 
13 use wcmf\lib\config\Configuration;
14 use wcmf\lib\core\Session;
15 use wcmf\lib\i18n\Localization;
16 use wcmf\lib\i18n\Message;
17 use wcmf\lib\persistence\concurrency\ConcurrencyManager;
18 use wcmf\lib\persistence\concurrency\Lock;
19 use wcmf\lib\persistence\concurrency\PessimisticLockException;
20 use wcmf\lib\persistence\ObjectId;
21 use wcmf\lib\persistence\PersistenceFacade;
22 use wcmf\lib\presentation\ActionMapper;
23 use wcmf\lib\presentation\ApplicationError;
24 use wcmf\lib\presentation\Controller;
25 use wcmf\lib\security\PermissionManager;
26 
27 /**
28  * ConcurrencyController is used to lock/unlock objects.
29  *
30  * The controller supports the following actions:
31  *
32  * <div class="controller-action">
33  * <div> __Action__ lock </div>
34  * <div>
35  * Lock an object.
36  * | Parameter | Description
37  * |-----------------------|-------------------------
38  * | _in_ / _out_ `oid` | The object id of the object to lock
39  * | _in_ / _out_ `type` | The lock type (_optimistic_ or _pessimistic_) (optional, default: _optimistic_)
40  * | __Response Actions__ | |
41  * | `ok` | In all cases
42  * </div>
43  * </div>
44  *
45  * <div class="controller-action">
46  * <div> __Action__ unlock </div>
47  * <div>
48  * Unlock an object.
49  * | Parameter | Description
50  * |-----------------------|-------------------------
51  * | _in_ / _out_ `oid` | The object id of the object to unlock
52  * | _in_ / _out_ `type` | The lock type (_optimistic_ or _pessimistic_) (optional, default: _optimistic_)
53  * | __Response Actions__ | |
54  * | `ok` | In all cases
55  * </div>
56  * </div>
57  *
58  * @note If the user already holds a pessimistic lock, and tries to aquire an
59  * optimistic lock, the returned lock type is still pessimistic.
60  *
61  * @author ingo herwig <ingo@wemove.com>
62  */
63 class ConcurrencyController extends Controller {
64 
65  private $concurrencyManager = null;
66 
67  /**
68  * Constructor
69  * @param $session
70  * @param $persistenceFacade
71  * @param $permissionManager
72  * @param $actionMapper
73  * @param $localization
74  * @param $message
75  * @param $configuration
76  * @param $concurrencyManager
77  */
78  public function __construct(Session $session,
79  PersistenceFacade $persistenceFacade,
80  PermissionManager $permissionManager,
81  ActionMapper $actionMapper,
82  Localization $localization,
83  Message $message,
84  Configuration $configuration,
85  ConcurrencyManager $concurrencyManager) {
86  parent::__construct($session, $persistenceFacade, $permissionManager,
87  $actionMapper, $localization, $message, $configuration);
88  $this->concurrencyManager = $concurrencyManager;
89  }
90 
91  /**
92  * @see Controller::validate()
93  */
94  protected function validate() {
95  $request = $this->getRequest();
96  $response = $this->getResponse();
97  $oid = ObjectId::parse($request->getValue('oid'));
98  if(!$oid) {
99  $response->addError(ApplicationError::get('OID_INVALID',
100  ['invalidOids' => [$request->getValue('oid')]]));
101  return false;
102  }
103  $lockType = $request->getValue('type', Lock::TYPE_OPTIMISTIC);
104  if (!in_array($lockType, [Lock::TYPE_OPTIMISTIC, Lock::TYPE_PESSIMISTIC])) {
105  $response->addError(ApplicationError::get('PARAMETER_INVALID',
106  ['invalidParameters' => ['type']]));
107  }
108  return true;
109  }
110 
111  /**
112  * @see Controller::doExecute()
113  */
114  protected function doExecute($method=null) {
115  $request = $this->getRequest();
116  $response = $this->getResponse();
117  $oid = ObjectId::parse($request->getValue('oid'));
118  $lockType = $request->getValue('type', Lock::TYPE_OPTIMISTIC);
119 
120  // process actions
121  try {
122  if ($request->getAction() == 'lock') {
123  $this->concurrencyManager->aquireLock($oid, $lockType);
124  $lock = $this->concurrencyManager->getLock($oid);
125  $response->setValue('type', $lock->getType());
126  }
127  elseif ($request->getAction() == 'unlock') {
128  $this->concurrencyManager->releaseLock($oid, $lockType);
129  }
130  }
131  catch (PessimisticLockException $ex) {
132  $response->addError(ApplicationError::get('OBJECT_IS_LOCKED',
133  ['lockedOids' => [$oid->__toString()]]));
134  }
135 
136  $response->setValue('oid', $oid);
137  $response->setAction('ok');
138  }
139 }
140 ?>