CRUDController.php 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  1. <?php
  2. /*
  3. * This file is part of the Sonata package.
  4. *
  5. * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Sonata\AdminBundle\Controller;
  11. use Symfony\Component\HttpFoundation\RedirectResponse;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\HttpKernel\Exception\HttpException;
  14. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  15. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  16. use Symfony\Component\DependencyInjection\ContainerInterface;
  17. use Symfony\Bundle\FrameworkBundle\Controller\Controller;
  18. use Sonata\AdminBundle\Exception\ModelManagerException;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
  21. use Sonata\AdminBundle\Admin\BaseFieldDescription;
  22. use Sonata\AdminBundle\Util\AdminObjectAclData;
  23. class CRUDController extends Controller
  24. {
  25. /**
  26. * The related Admin class
  27. *
  28. * @var \Sonata\AdminBundle\Admin\AdminInterface
  29. */
  30. protected $admin;
  31. /**
  32. * @param mixed $data
  33. * @param integer $status
  34. * @param array $headers
  35. *
  36. * @return Response with json encoded data
  37. */
  38. public function renderJson($data, $status = 200, $headers = array())
  39. {
  40. // fake content-type so browser does not show the download popup when this
  41. // response is rendered through an iframe (used by the jquery.form.js plugin)
  42. // => don't know yet if it is the best solution
  43. if ($this->get('request')->get('_xml_http_request')
  44. && strpos($this->get('request')->headers->get('Content-Type'), 'multipart/form-data') === 0) {
  45. $headers['Content-Type'] = 'text/plain';
  46. } else {
  47. $headers['Content-Type'] = 'application/json';
  48. }
  49. return new Response(json_encode($data), $status, $headers);
  50. }
  51. /**
  52. *
  53. * @return boolean true if the request is done by an ajax like query
  54. */
  55. public function isXmlHttpRequest()
  56. {
  57. return $this->get('request')->isXmlHttpRequest() || $this->get('request')->get('_xml_http_request');
  58. }
  59. /**
  60. * Returns the correct RESTful verb, given either by the request itself or
  61. * via the "_method" parameter.
  62. *
  63. * @return string HTTP method, either
  64. */
  65. protected function getRestMethod()
  66. {
  67. $request = $this->getRequest();
  68. if (Request::getHttpMethodParameterOverride() || !$request->request->has('_method')) {
  69. return $request->getMethod();
  70. }
  71. return $request->request->get('_method');
  72. }
  73. /**
  74. * Sets the Container associated with this Controller.
  75. *
  76. * @param ContainerInterface $container A ContainerInterface instance
  77. */
  78. public function setContainer(ContainerInterface $container = null)
  79. {
  80. $this->container = $container;
  81. $this->configure();
  82. }
  83. /**
  84. * Contextualize the admin class depends on the current request
  85. *
  86. * @throws \RuntimeException
  87. * @return void
  88. */
  89. public function configure()
  90. {
  91. $adminCode = $this->container->get('request')->get('_sonata_admin');
  92. if (!$adminCode) {
  93. throw new \RuntimeException(sprintf('There is no `_sonata_admin` defined for the controller `%s` and the current route `%s`', get_class($this), $this->container->get('request')->get('_route')));
  94. }
  95. $this->admin = $this->container->get('sonata.admin.pool')->getAdminByAdminCode($adminCode);
  96. if (!$this->admin) {
  97. throw new \RuntimeException(sprintf('Unable to find the admin class related to the current controller (%s)', get_class($this)));
  98. }
  99. $rootAdmin = $this->admin;
  100. if ($this->admin->isChild()) {
  101. $this->admin->setCurrentChild(true);
  102. $rootAdmin = $rootAdmin->getParent();
  103. }
  104. $request = $this->container->get('request');
  105. $rootAdmin->setRequest($request);
  106. if ($request->get('uniqid')) {
  107. $this->admin->setUniqid($request->get('uniqid'));
  108. }
  109. }
  110. /**
  111. * return the base template name
  112. *
  113. * @return string the template name
  114. */
  115. public function getBaseTemplate()
  116. {
  117. if ($this->isXmlHttpRequest()) {
  118. return $this->admin->getTemplate('ajax');
  119. }
  120. return $this->admin->getTemplate('layout');
  121. }
  122. /**
  123. * @param string $view
  124. * @param array $parameters
  125. * @param Response $response
  126. *
  127. * @return Response
  128. */
  129. public function render($view, array $parameters = array(), Response $response = null)
  130. {
  131. $parameters['admin'] = isset($parameters['admin']) ? $parameters['admin'] : $this->admin;
  132. $parameters['base_template'] = isset($parameters['base_template']) ? $parameters['base_template'] : $this->getBaseTemplate();
  133. $parameters['admin_pool'] = $this->get('sonata.admin.pool');
  134. return parent::render($view, $parameters, $response);
  135. }
  136. /**
  137. * return the Response object associated to the list action
  138. *
  139. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  140. *
  141. * @return Response
  142. */
  143. public function listAction()
  144. {
  145. if (false === $this->admin->isGranted('LIST')) {
  146. throw new AccessDeniedException();
  147. }
  148. $datagrid = $this->admin->getDatagrid();
  149. $formView = $datagrid->getForm()->createView();
  150. // set the theme for the current Admin Form
  151. $this->get('twig')->getExtension('form')->renderer->setTheme($formView, $this->admin->getFilterTheme());
  152. return $this->render($this->admin->getTemplate('list'), array(
  153. 'action' => 'list',
  154. 'form' => $formView,
  155. 'datagrid' => $datagrid,
  156. 'csrf_token' => $this->getCsrfToken('sonata.batch'),
  157. ));
  158. }
  159. /**
  160. * execute a batch delete
  161. *
  162. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  163. *
  164. * @param \Sonata\AdminBundle\Datagrid\ProxyQueryInterface $query
  165. *
  166. * @return \Symfony\Component\HttpFoundation\RedirectResponse
  167. */
  168. public function batchActionDelete(ProxyQueryInterface $query)
  169. {
  170. if (false === $this->admin->isGranted('DELETE')) {
  171. throw new AccessDeniedException();
  172. }
  173. $modelManager = $this->admin->getModelManager();
  174. try {
  175. $modelManager->batchDelete($this->admin->getClass(), $query);
  176. $this->addFlash('sonata_flash_success', 'flash_batch_delete_success');
  177. } catch ( ModelManagerException $e ) {
  178. $this->addFlash('sonata_flash_error', 'flash_batch_delete_error');
  179. }
  180. return new RedirectResponse($this->admin->generateUrl('list', array('filter' => $this->admin->getFilterParameters())));
  181. }
  182. /**
  183. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException|\Symfony\Component\Security\Core\Exception\AccessDeniedException
  184. *
  185. * @param mixed $id
  186. *
  187. * @return Response|RedirectResponse
  188. */
  189. public function deleteAction($id)
  190. {
  191. $id = $this->get('request')->get($this->admin->getIdParameter());
  192. $object = $this->admin->getObject($id);
  193. if (!$object) {
  194. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  195. }
  196. if (false === $this->admin->isGranted('DELETE', $object)) {
  197. throw new AccessDeniedException();
  198. }
  199. if ($this->getRestMethod() == 'DELETE') {
  200. // check the csrf token
  201. $this->validateCsrfToken('sonata.delete');
  202. try {
  203. $this->admin->delete($object);
  204. if ($this->isXmlHttpRequest()) {
  205. return $this->renderJson(array('result' => 'ok'));
  206. }
  207. $this->addFlash(
  208. 'sonata_flash_success',
  209. $this->admin->trans('flash_delete_success', array('%name%' => $this->admin->toString($object)),
  210. 'SonataAdminBundle')
  211. );
  212. } catch (ModelManagerException $e) {
  213. if ($this->isXmlHttpRequest()) {
  214. return $this->renderJson(array('result' => 'error'));
  215. }
  216. $this->addFlash(
  217. 'sonata_flash_error',
  218. $this->admin->trans('flash_delete_error', array('%name%' => $this->admin->toString($object)),
  219. 'SonataAdminBundle')
  220. );
  221. }
  222. return new RedirectResponse($this->admin->generateUrl('list'));
  223. }
  224. return $this->render($this->admin->getTemplate('delete'), array(
  225. 'object' => $object,
  226. 'action' => 'delete',
  227. 'csrf_token' => $this->getCsrfToken('sonata.delete')
  228. ));
  229. }
  230. /**
  231. * return the Response object associated to the edit action
  232. *
  233. *
  234. * @param mixed $id
  235. *
  236. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  237. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
  238. *
  239. * @return Response
  240. */
  241. public function editAction($id = null)
  242. {
  243. // the key used to lookup the template
  244. $templateKey = 'edit';
  245. $id = $this->get('request')->get($this->admin->getIdParameter());
  246. $object = $this->admin->getObject($id);
  247. if (!$object) {
  248. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  249. }
  250. if (false === $this->admin->isGranted('EDIT', $object)) {
  251. throw new AccessDeniedException();
  252. }
  253. $this->admin->setSubject($object);
  254. /** @var $form \Symfony\Component\Form\Form */
  255. $form = $this->admin->getForm();
  256. $form->setData($object);
  257. if ($this->getRestMethod() == 'POST') {
  258. $form->bind($this->get('request'));
  259. $isFormValid = $form->isValid();
  260. // persist if the form was valid and if in preview mode the preview was approved
  261. if ($isFormValid && (!$this->isInPreviewMode() || $this->isPreviewApproved())) {
  262. $this->admin->update($object);
  263. if ($this->isXmlHttpRequest()) {
  264. return $this->renderJson(array(
  265. 'result' => 'ok',
  266. 'objectId' => $this->admin->getNormalizedIdentifier($object)
  267. ));
  268. }
  269. $this->addFlash('sonata_flash_success', $this->admin->trans('flash_edit_success', array('%name%' => $this->admin->toString($object)), 'SonataAdminBundle'));
  270. // redirect to edit mode
  271. return $this->redirectTo($object);
  272. }
  273. // show an error message if the form failed validation
  274. if (!$isFormValid) {
  275. if (!$this->isXmlHttpRequest()) {
  276. $this->addFlash('sonata_flash_error', $this->admin->trans('flash_edit_error', array('%name%' => $this->admin->toString($object)), 'SonataAdminBundle'));
  277. }
  278. } elseif ($this->isPreviewRequested()) {
  279. // enable the preview template if the form was valid and preview was requested
  280. $templateKey = 'preview';
  281. $this->admin->getShow();
  282. }
  283. }
  284. $view = $form->createView();
  285. // set the theme for the current Admin Form
  286. $this->get('twig')->getExtension('form')->renderer->setTheme($view, $this->admin->getFormTheme());
  287. return $this->render($this->admin->getTemplate($templateKey), array(
  288. 'action' => 'edit',
  289. 'form' => $view,
  290. 'object' => $object,
  291. ));
  292. }
  293. /**
  294. * redirect the user depend on this choice
  295. *
  296. * @param object $object
  297. *
  298. * @return Response
  299. */
  300. public function redirectTo($object)
  301. {
  302. $url = false;
  303. if ($this->get('request')->get('btn_update_and_list')) {
  304. $url = $this->admin->generateUrl('list');
  305. }
  306. if ($this->get('request')->get('btn_create_and_list')) {
  307. $url = $this->admin->generateUrl('list');
  308. }
  309. if ($this->get('request')->get('btn_create_and_create')) {
  310. $params = array();
  311. if ($this->admin->hasActiveSubClass()) {
  312. $params['subclass'] = $this->get('request')->get('subclass');
  313. }
  314. $url = $this->admin->generateUrl('create', $params);
  315. }
  316. if (!$url) {
  317. $url = $this->admin->generateObjectUrl('edit', $object);
  318. }
  319. return new RedirectResponse($url);
  320. }
  321. /**
  322. * return the Response object associated to the batch action
  323. *
  324. * @throws \RuntimeException
  325. * @return Response
  326. */
  327. public function batchAction()
  328. {
  329. if ($this->getRestMethod() != 'POST') {
  330. throw new \RuntimeException('invalid request type, POST expected');
  331. }
  332. // check the csrf token
  333. $this->validateCsrfToken('sonata.batch');
  334. $confirmation = $this->get('request')->get('confirmation', false);
  335. if ($data = json_decode($this->get('request')->get('data'), true)) {
  336. $action = $data['action'];
  337. $idx = $data['idx'];
  338. $allElements = $data['all_elements'];
  339. $this->get('request')->request->replace($data);
  340. } else {
  341. $this->get('request')->request->set('idx', $this->get('request')->get('idx', array()));
  342. $this->get('request')->request->set('all_elements', $this->get('request')->get('all_elements', false));
  343. $action = $this->get('request')->get('action');
  344. $idx = $this->get('request')->get('idx');
  345. $allElements = $this->get('request')->get('all_elements');
  346. $data = $this->get('request')->request->all();
  347. unset($data['_sonata_csrf_token']);
  348. }
  349. $batchActions = $this->admin->getBatchActions();
  350. if (!array_key_exists($action, $batchActions)) {
  351. throw new \RuntimeException(sprintf('The `%s` batch action is not defined', $action));
  352. }
  353. $camelizedAction = BaseFieldDescription::camelize($action);
  354. $isRelevantAction = sprintf('batchAction%sIsRelevant', ucfirst($camelizedAction));
  355. if (method_exists($this, $isRelevantAction)) {
  356. $nonRelevantMessage = call_user_func(array($this, $isRelevantAction), $idx, $allElements);
  357. } else {
  358. $nonRelevantMessage = count($idx) != 0 || $allElements; // at least one item is selected
  359. }
  360. if (!$nonRelevantMessage) { // default non relevant message (if false of null)
  361. $nonRelevantMessage = 'flash_batch_empty';
  362. }
  363. $datagrid = $this->admin->getDatagrid();
  364. $datagrid->buildPager();
  365. if (true !== $nonRelevantMessage) {
  366. $this->addFlash('sonata_flash_info', $nonRelevantMessage);
  367. return new RedirectResponse($this->admin->generateUrl('list', array('filter' => $this->admin->getFilterParameters())));
  368. }
  369. $askConfirmation = isset($batchActions[$action]['ask_confirmation']) ? $batchActions[$action]['ask_confirmation'] : true;
  370. if ($askConfirmation && $confirmation != 'ok') {
  371. $actionLabel = $this->admin->trans($this->admin->getTranslationLabel($action, 'action'));
  372. $formView = $datagrid->getForm()->createView();
  373. return $this->render($this->admin->getTemplate('batch_confirmation'), array(
  374. 'action' => 'list',
  375. 'action_label' => $actionLabel,
  376. 'datagrid' => $datagrid,
  377. 'form' => $formView,
  378. 'data' => $data,
  379. 'csrf_token' => $this->getCsrfToken('sonata.batch'),
  380. ));
  381. }
  382. // execute the action, batchActionXxxxx
  383. $finalAction = sprintf('batchAction%s', ucfirst($camelizedAction));
  384. if (!method_exists($this, $finalAction)) {
  385. throw new \RuntimeException(sprintf('A `%s::%s` method must be created', get_class($this), $finalAction));
  386. }
  387. $query = $datagrid->getQuery();
  388. $query->setFirstResult(null);
  389. $query->setMaxResults(null);
  390. if (count($idx) > 0) {
  391. $this->admin->getModelManager()->addIdentifiersToQuery($this->admin->getClass(), $query, $idx);
  392. } elseif (!$allElements) {
  393. $query = null;
  394. }
  395. return call_user_func(array($this, $finalAction), $query);
  396. }
  397. /**
  398. * return the Response object associated to the create action
  399. *
  400. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  401. * @return Response
  402. */
  403. public function createAction()
  404. {
  405. // the key used to lookup the template
  406. $templateKey = 'edit';
  407. if (false === $this->admin->isGranted('CREATE')) {
  408. throw new AccessDeniedException();
  409. }
  410. $object = $this->admin->getNewInstance();
  411. $this->admin->setSubject($object);
  412. /** @var $form \Symfony\Component\Form\Form */
  413. $form = $this->admin->getForm();
  414. $form->setData($object);
  415. if ($this->getRestMethod()== 'POST') {
  416. $form->bind($this->get('request'));
  417. $isFormValid = $form->isValid();
  418. // persist if the form was valid and if in preview mode the preview was approved
  419. if ($isFormValid && (!$this->isInPreviewMode() || $this->isPreviewApproved())) {
  420. $this->admin->create($object);
  421. if ($this->isXmlHttpRequest()) {
  422. return $this->renderJson(array(
  423. 'result' => 'ok',
  424. 'objectId' => $this->admin->getNormalizedIdentifier($object)
  425. ));
  426. }
  427. $this->addFlash('sonata_flash_success', $this->admin->trans('flash_create_success', array('%name%' => $this->admin->toString($object)), 'SonataAdminBundle'));
  428. // redirect to edit mode
  429. return $this->redirectTo($object);
  430. }
  431. // show an error message if the form failed validation
  432. if (!$isFormValid) {
  433. if (!$this->isXmlHttpRequest()) {
  434. $this->addFlash('sonata_flash_error', 'flash_create_error');
  435. }
  436. } elseif ($this->isPreviewRequested()) {
  437. // pick the preview template if the form was valid and preview was requested
  438. $templateKey = 'preview';
  439. $this->admin->getShow();
  440. }
  441. }
  442. $view = $form->createView();
  443. // set the theme for the current Admin Form
  444. $this->get('twig')->getExtension('form')->renderer->setTheme($view, $this->admin->getFormTheme());
  445. return $this->render($this->admin->getTemplate($templateKey), array(
  446. 'action' => 'create',
  447. 'form' => $view,
  448. 'object' => $object,
  449. ));
  450. }
  451. /**
  452. * Returns true if the preview is requested to be shown
  453. *
  454. * @return boolean
  455. */
  456. protected function isPreviewRequested()
  457. {
  458. return ($this->get('request')->get('btn_preview') !== null);
  459. }
  460. /**
  461. * Returns true if the preview has been approved
  462. *
  463. * @return boolean
  464. */
  465. protected function isPreviewApproved()
  466. {
  467. return ($this->get('request')->get('btn_preview_approve') !== null);
  468. }
  469. /**
  470. * Returns true if the request is in the preview workflow
  471. *
  472. * That means either a preview is requested or the preview has already been shown
  473. * and it got approved/declined.
  474. *
  475. * @return boolean
  476. */
  477. protected function isInPreviewMode()
  478. {
  479. return $this->admin->supportsPreviewMode()
  480. && ($this->isPreviewRequested()
  481. || $this->isPreviewApproved()
  482. || $this->isPreviewDeclined());
  483. }
  484. /**
  485. * Returns true if the preview has been declined
  486. *
  487. * @return boolean
  488. */
  489. protected function isPreviewDeclined()
  490. {
  491. return ($this->get('request')->get('btn_preview_decline') !== null);
  492. }
  493. /**
  494. * return the Response object associated to the view action
  495. *
  496. * @param null $id
  497. *
  498. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  499. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
  500. *
  501. * @return Response
  502. */
  503. public function showAction($id = null)
  504. {
  505. $id = $this->get('request')->get($this->admin->getIdParameter());
  506. $object = $this->admin->getObject($id);
  507. if (!$object) {
  508. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  509. }
  510. if (false === $this->admin->isGranted('VIEW', $object)) {
  511. throw new AccessDeniedException();
  512. }
  513. $this->admin->setSubject($object);
  514. return $this->render($this->admin->getTemplate('show'), array(
  515. 'action' => 'show',
  516. 'object' => $object,
  517. 'elements' => $this->admin->getShow(),
  518. ));
  519. }
  520. /**
  521. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException|\Symfony\Component\Security\Core\Exception\AccessDeniedException
  522. *
  523. * @param mixed $id
  524. *
  525. * @return Response
  526. */
  527. public function historyAction($id = null)
  528. {
  529. if (false === $this->admin->isGranted('EDIT')) {
  530. throw new AccessDeniedException();
  531. }
  532. $id = $this->get('request')->get($this->admin->getIdParameter());
  533. $object = $this->admin->getObject($id);
  534. if (!$object) {
  535. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  536. }
  537. $manager = $this->get('sonata.admin.audit.manager');
  538. if (!$manager->hasReader($this->admin->getClass())) {
  539. throw new NotFoundHttpException(sprintf('unable to find the audit reader for class : %s', $this->admin->getClass()));
  540. }
  541. $reader = $manager->getReader($this->admin->getClass());
  542. $revisions = $reader->findRevisions($this->admin->getClass(), $id);
  543. return $this->render($this->admin->getTemplate('history'), array(
  544. 'action' => 'history',
  545. 'object' => $object,
  546. 'revisions' => $revisions,
  547. ));
  548. }
  549. /**
  550. * @param null $id
  551. * @param string $revision
  552. *
  553. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  554. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
  555. *
  556. * @return Response
  557. */
  558. public function historyViewRevisionAction($id = null, $revision = null)
  559. {
  560. if (false === $this->admin->isGranted('EDIT')) {
  561. throw new AccessDeniedException();
  562. }
  563. $id = $this->get('request')->get($this->admin->getIdParameter());
  564. $object = $this->admin->getObject($id);
  565. if (!$object) {
  566. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  567. }
  568. $manager = $this->get('sonata.admin.audit.manager');
  569. if (!$manager->hasReader($this->admin->getClass())) {
  570. throw new NotFoundHttpException(sprintf('unable to find the audit reader for class : %s', $this->admin->getClass()));
  571. }
  572. $reader = $manager->getReader($this->admin->getClass());
  573. // retrieve the revisioned object
  574. $object = $reader->find($this->admin->getClass(), $id, $revision);
  575. if (!$object) {
  576. throw new NotFoundHttpException(sprintf('unable to find the targeted object `%s` from the revision `%s` with classname : `%s`', $id, $revision, $this->admin->getClass()));
  577. }
  578. $this->admin->setSubject($object);
  579. return $this->render($this->admin->getTemplate('show'), array(
  580. 'action' => 'show',
  581. 'object' => $object,
  582. 'elements' => $this->admin->getShow(),
  583. ));
  584. }
  585. /**
  586. * @param Request $request
  587. *
  588. * @throws \RuntimeException
  589. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  590. *
  591. * @return Response
  592. */
  593. public function exportAction(Request $request)
  594. {
  595. if (false === $this->admin->isGranted('EXPORT')) {
  596. throw new AccessDeniedException();
  597. }
  598. $format = $request->get('format');
  599. $allowedExportFormats = (array) $this->admin->getExportFormats();
  600. if (!in_array($format, $allowedExportFormats) ) {
  601. throw new \RuntimeException(sprintf('Export in format `%s` is not allowed for class: `%s`. Allowed formats are: `%s`', $format, $this->admin->getClass(), implode(', ', $allowedExportFormats)));
  602. }
  603. $filename = sprintf('export_%s_%s.%s',
  604. strtolower(substr($this->admin->getClass(), strripos($this->admin->getClass(), '\\') + 1)),
  605. date('Y_m_d_H_i_s', strtotime('now')),
  606. $format
  607. );
  608. return $this->get('sonata.admin.exporter')->getResponse($format, $filename, $this->admin->getDataSourceIterator());
  609. }
  610. /**
  611. * Gets ACL users
  612. *
  613. * @return \Traversable
  614. */
  615. protected function getAclUsers()
  616. {
  617. $aclUsers = array();
  618. $userManagerServiceName = $this->container->getParameter('sonata.admin.security.acl_user_manager');
  619. if ($userManagerServiceName !== null && $this->has($userManagerServiceName)) {
  620. $userManager = $this->get($userManagerServiceName);
  621. if (method_exists($userManager, 'findUsers')) {
  622. $aclUsers = $userManager->findUsers();
  623. }
  624. }
  625. return is_array($aclUsers) ? new \ArrayIterator($aclUsers) : $aclUsers;
  626. }
  627. /**
  628. * return the Response object associated to the acl action
  629. *
  630. * @param null $id
  631. *
  632. * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedException
  633. * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
  634. *
  635. * @return Response
  636. */
  637. public function aclAction($id = null)
  638. {
  639. if (!$this->admin->isAclEnabled()) {
  640. throw new NotFoundHttpException('ACL are not enabled for this admin');
  641. }
  642. $id = $this->get('request')->get($this->admin->getIdParameter());
  643. $object = $this->admin->getObject($id);
  644. if (!$object) {
  645. throw new NotFoundHttpException(sprintf('unable to find the object with id : %s', $id));
  646. }
  647. if (false === $this->admin->isGranted('MASTER', $object)) {
  648. throw new AccessDeniedException();
  649. }
  650. $this->admin->setSubject($object);
  651. $aclUsers = $this->getAclUsers();
  652. $adminObjectAclManipulator = $this->get('sonata.admin.object.manipulator.acl.admin');
  653. $adminObjectAclData = new AdminObjectAclData(
  654. $this->admin,
  655. $object,
  656. $aclUsers,
  657. $adminObjectAclManipulator->getMaskBuilderClass()
  658. );
  659. $form = $adminObjectAclManipulator->createForm($adminObjectAclData);
  660. $request = $this->getRequest();
  661. if ($request->getMethod() === 'POST') {
  662. $form->bind($request);
  663. if ($form->isValid()) {
  664. $adminObjectAclManipulator->updateAcl($adminObjectAclData);
  665. $this->addFlash('sonata_flash_success', 'flash_acl_edit_success');
  666. return new RedirectResponse($this->admin->generateObjectUrl('acl', $object));
  667. }
  668. }
  669. return $this->render($this->admin->getTemplate('acl'), array(
  670. 'action' => 'acl',
  671. 'permissions' => $adminObjectAclData->getUserPermissions(),
  672. 'object' => $object,
  673. 'users' => $aclUsers,
  674. 'form' => $form->createView()
  675. ));
  676. }
  677. /**
  678. * Adds a flash message for type.
  679. *
  680. * @param string $type
  681. * @param string $message
  682. */
  683. public function addFlash($type, $message)
  684. {
  685. $this->get('session')
  686. ->getFlashBag()
  687. ->add($type, $message);
  688. }
  689. /**
  690. * Validate CSRF token for action with out form
  691. *
  692. * @param string $intention
  693. *
  694. * @throws \RuntimeException
  695. */
  696. public function validateCsrfToken($intention)
  697. {
  698. if (!$this->container->has('form.csrf_provider')) {
  699. return;
  700. }
  701. if (!$this->container->get('form.csrf_provider')->isCsrfTokenValid($intention, $this->get('request')->request->get('_sonata_csrf_token', false))) {
  702. throw new HttpException(400, "The csrf token is not valid, CSRF attack ?");
  703. }
  704. }
  705. /**
  706. * @param $intention
  707. *
  708. * @return string
  709. */
  710. public function getCsrfToken($intention)
  711. {
  712. if (!$this->container->has('form.csrf_provider')) {
  713. return false;
  714. }
  715. return $this->container->get('form.csrf_provider')->generateCsrfToken($intention);
  716. }
  717. }