src/Entity/Document.php line 66

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
  6. use Doctrine\Common\Collections\Collection as DoctrineCollection;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Gedmo\Mapping\Annotation as Gedmo;
  9. use JsonSerializable;
  10. use MedBrief\MSR\Repository\DocumentRepository;
  11. use MedBrief\MSR\Service\File\FileHandler\FileHandledInterface;
  12. use MedBrief\MSR\Service\MimeTypes;
  13. use MedBrief\MSR\Service\ProjectClosure\RemoveRecords\RemovableRecordInterface;
  14. use MedBrief\MSR\Service\VirusScan\Async\VirusScannableInterface;
  15. use MedBrief\MSR\Service\VirusScan\Async\Visitor\VirusScannerPathVisitorInterface;
  17. /**
  18. * Document
  19. *
  20. * @ORM\Table(name="Document", indexes={@ORM\Index(name="created_index", columns={"created"}), @ORM\Index(name="deletedAt_index", columns={"deletedAt"}), @ORM\Index(name="convertedToSwfStatus_index", columns={"convertedToSwfStatus"}), @ORM\Index(name="convertedToOptimizedPdfStatus_index", columns={"convertedToOptimizedPdfStatus"}), @ORM\Index(name="convertedToXodStatus_index", columns={"convertedToXodStatus"}), @ORM\Index(name="convertedToOcrStatus_index", columns={"convertedToOcrStatus"}), @ORM\Index(name="convertedToWebAVStatus_index", columns={"convertedToWebAVStatus"}), @ORM\Index(name="orthanc_store_response_id_index", columns={"orthanc_store_response_id"}), @ORM\Index(name="orthanc_parent_series_id_index", columns={"orthanc_parent_series_id"})})
  21. *
  22. * @\ApiPlatform\Core\Annotation\ApiResource(
  23. * collectionOperations={},
  24. * itemOperations={
  25. * "project_document_get_data"={
  26. * "method"="GET",
  27. * "path"="/matter/{id}/documents/{documentId}/get-data",
  28. * "controller"="MedBrief\MSR\Controller\ProjectDocumentController::getDataAction",
  29. * "read"=false,
  30. * "deserialize"=false,
  31. * "output"="MedBrief\MSR\Dto\ProjectDocument\ProjectDocumentDetailsDto",
  32. * "normalization_context"={"groups"={"project_document:get_data"}},
  33. * "defaults"={"_api_receive"=false},
  34. * "openapi_context"={
  35. * "summary"="Get project document details",
  36. * "description"="Returns aggregate project-document details (core Document fields plus DocumentMetadata when available).",
  37. * "parameters"={
  38. * {
  39. * "name"="id",
  40. * "in"="path",
  41. * "required"=true,
  42. * "schema"={"type"="integer"},
  43. * "description"="Project ID"
  44. * },
  45. * {
  46. * "name"="documentId",
  47. * "in"="path",
  48. * "required"=true,
  49. * "schema"={"type"="integer"},
  50. * "description"="Document ID"
  51. * }
  52. * }
  53. * }
  54. * }
  55. * }
  56. * )
  57. *
  58. * @ORM\Entity(repositoryClass=DocumentRepository::class)
  59. *
  60. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
  61. *
  62. * @Audit\Auditable
  63. *
  64. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
  65. */
  66. class Document implements JsonSerializable, RemovableRecordInterface, VirusScannableInterface, FileHandledInterface
  67. {
  68. public const ORTHANC_STORAGE_STATUS_PENDING = 1;
  69. public const ORTHANC_STORAGE_STATUS_STORED = 2;
  70. public const ORTHANC_STORAGE_STATUS_FAILED = 3;
  71. public const ORTHANC_STORAGE_STATUS_DELETED = 4;
  73. public const CONVERSION_TO_SWF_PENDING = 0;
  74. public const CONVERSION_TO_SWF_COMPLETE = 1;
  75. public const CONVERSION_TO_SWF_FAILED = 2;
  76. public const CONVERSION_TO_SWF_CURRENT = 3;
  77. public const CONVERSION_TO_SWF_SKIPPED = 4;
  79. // These statuses control the Archive state of the Document,
  80. // which applies to SWF conversion.
  81. public const CONVERSION_TO_SWF_ARCHIVE_PENDING = 5;
  82. public const CONVERSION_TO_SWF_ARCHIVE_CURRENT = 6;
  83. public const CONVERSION_TO_SWF_ARCHIVED = 7;
  84. public const CONVERSION_TO_SWF_ARCHIVE_FAILED = 8;
  86. public const FILE_TYPE_PDF = 'pdf';
  87. public const FILE_TYPE_AUDIO = 'audio';
  88. public const FILE_TYPE_VIDEO = 'video';
  89. public const FILE_TYPE_DICOM = 'dicom';
  90. public const FILE_TYPE_MSWORD = 'msword';
  91. public const FILE_TYPE_MSEXCEL = 'msexcel';
  92. public const FILE_TYPE_MSPOWERPOINT = 'mspowerpoint';
  93. public const FILE_TYPE_FILE = 'generic';
  94. public const FILE_TYPE_IMAGE = 'image';
  95. public const FILE_TYPE_TEXT_HTML = 'text/html';
  96. public const FILE_TYPE_EML_MSG = 'email';
  98. // Converted to OptimizedPDF statuses.
  99. public const CONVERSION_TO_OPTIMIZED_PDF_PENDING = 1;
  100. public const CONVERSION_TO_OPTIMIZED_PDF_COMPLETE = 2;
  101. public const CONVERSION_TO_OPTIMIZED_PDF_FAILED = 3;
  102. public const CONVERSION_TO_OPTIMIZED_PDF_CURRENT = 4;
  103. public const CONVERSION_TO_OPTIMIZED_PDF_SKIPPED = 5;
  105. // Converted to XOD statuses.
  106. public const CONVERSION_TO_XOD_PENDING = 1;
  107. public const CONVERSION_TO_XOD_COMPLETE = 2;
  108. public const CONVERSION_TO_XOD_FAILED = 3;
  109. public const CONVERSION_TO_XOD_CURRENT = 4;
  110. public const CONVERSION_TO_XOD_SKIPPED = 5;
  111. public const CONVERSION_TO_XOD_ENCRYPTED = 6;
  113. // Converted to WEBAV statuses.
  114. public const CONVERSION_TO_WEBAV_PENDING = 1;
  115. public const CONVERSION_TO_WEBAV_COMPLETE = 2;
  116. public const CONVERSION_TO_WEBAV_FAILED = 3;
  117. public const CONVERSION_TO_WEBAV_CURRENT = 4;
  118. public const CONVERSION_TO_WEBAV_SKIPPED = 5;
  120. // Converted to OCR statuses.
  121. public const CONVERSION_TO_OCR_PENDING = 1;
  122. public const CONVERSION_TO_OCR_COMPLETE = 2;
  123. public const CONVERSION_TO_OCR_FAILED = 3;
  124. public const CONVERSION_TO_OCR_FAILED_AUTH = 31;
  125. public const CONVERSION_TO_OCR_FAILED_HTTP_TRANSPORT = 32;
  126. public const CONVERSION_TO_OCR_FAILED_NO_PDF_PATH = 33;
  127. public const CONVERSION_TO_OCR_CURRENT = 4;
  128. public const CONVERSION_TO_OCR_SKIPPED = 5;
  129. public const CONVERSION_TO_OCR_REQUEUED = 6;
  131. public const FILE_FIELD_LIST = [
  132. 'nativeFile',
  133. 'optimizedPdfFile',
  134. 'xodBlobFile',
  135. 'ocrFile',
  136. 'ocrXodBlobFile',
  137. 'webAVFile',
  138. ];
  140. public static $fileIcons = [
  141. 'afl' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  142. 'aif' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  143. 'aifc' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  144. 'aiff' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  145. 'asf' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  146. 'asx' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  147. 'au' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  148. 'avi' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  149. 'avs' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  150. 'dif' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  151. 'dl' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  152. 'dv' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  153. 'dvr-ms' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  154. 'fli' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  155. 'fmf' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  156. 'funk' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  157. 'gl' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  158. 'gsd' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  159. 'gsm' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  160. 'isu' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  161. 'it' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  162. 'jam' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  163. 'kar' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  164. 'la' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  165. 'lam' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  166. 'lma' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  167. 'm1v' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  168. 'm2a' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  169. 'm2v' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  170. 'm3u' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  171. 'mid' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  172. 'midi' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  173. 'mjf' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  174. 'mjpg' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  175. 'mkv' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  176. 'mod' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  177. 'moov' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  178. 'mov' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  179. 'movie' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  180. 'mp2' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  181. 'mp3' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  182. 'mp4' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  183. 'mpa' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  184. 'mpe' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  185. 'mpeg' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  186. 'mpg' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  187. 'mpga' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  188. 'mv' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  189. 'my' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  190. 'pfunk' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  191. 'qcp' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  192. 'qt' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  193. 'qtc' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  194. 'ra' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  195. 'ram' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  196. 'rm' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  197. 'rmi' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  198. 'rmm' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  199. 'rmp' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  200. 'rpm' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  201. 'rv' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  202. 's3m' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  203. 'scm' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  204. 'sid' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  205. 'snd' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  206. 'tsi' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  207. 'tsp' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  208. 'vdo' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  209. 'viv' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  210. 'vivo' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  211. 'voc' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  212. 'vos' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  213. 'vox' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  214. 'vqe' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  215. 'vqf' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  216. 'vql' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  217. 'wav' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  218. 'xdr' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  219. 'xm' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  220. 'xsr' => ['iconClass' => 'mb-icon--video', 'type' => self::FILE_TYPE_VIDEO],
  221. 'wma' => ['iconClass' => 'mb-icon--audio', 'type' => self::FILE_TYPE_AUDIO],
  223. // PDF file
  224. 'pdf' => ['iconClass' => 'mb-icon--pdf', 'type' => self::FILE_TYPE_PDF],
  226. // generic file
  227. 'xps' => ['iconClass' => 'mb-icon--file', 'type' => self::FILE_TYPE_FILE],
  228. 'rtf' => ['iconClass' => 'mb-icon--file', 'type' => self::FILE_TYPE_FILE],
  229. 'csv' => ['iconClass' => 'mb-icon--file', 'type' => self::FILE_TYPE_FILE],
  230. 'vsd' => ['iconClass' => 'mb-icon--file', 'type' => self::FILE_TYPE_FILE],
  231. 'pub' => ['iconClass' => 'mb-icon--file', 'type' => self::FILE_TYPE_FILE],
  233. // Word files
  234. 'doc' => ['iconClass' => 'mb-icon--ms-word', 'type' => self::FILE_TYPE_MSWORD],
  235. 'dot' => ['iconClass' => 'mb-icon--ms-word', 'type' => self::FILE_TYPE_MSWORD],
  236. 'docx' => ['iconClass' => 'mb-icon--ms-word', 'type' => self::FILE_TYPE_MSWORD],
  237. 'dotx' => ['iconClass' => 'mb-icon--ms-word', 'type' => self::FILE_TYPE_MSWORD],
  239. // Excel files
  240. 'xls' => ['iconClass' => 'mb-icon--ms-excel', 'type' => self::FILE_TYPE_MSEXCEL],
  241. 'xlt' => ['iconClass' => 'mb-icon--ms-excel', 'type' => self::FILE_TYPE_MSEXCEL],
  242. 'xla' => ['iconClass' => 'mb-icon--ms-excel', 'type' => self::FILE_TYPE_MSEXCEL],
  243. 'xlsx' => ['iconClass' => 'mb-icon--ms-excel', 'type' => self::FILE_TYPE_MSEXCEL],
  244. 'ods' => ['iconClass' => 'mb-icon--ms-excel', 'type' => self::FILE_TYPE_MSEXCEL],
  246. // PowerPoint files
  247. 'ppt' => ['iconClass' => 'mb-icon--ms-powerpoint', 'type' => self::FILE_TYPE_MSPOWERPOINT],
  248. 'pot' => ['iconClass' => 'mb-icon--ms-powerpoint', 'type' => self::FILE_TYPE_MSPOWERPOINT],
  249. 'pps' => ['iconClass' => 'mb-icon--ms-powerpoint', 'type' => self::FILE_TYPE_MSPOWERPOINT],
  250. 'ppa' => ['iconClass' => 'mb-icon--ms-powerpoint', 'type' => self::FILE_TYPE_MSPOWERPOINT],
  251. 'pptx' => ['iconClass' => 'mb-icon--ms-powerpoint', 'type' => self::FILE_TYPE_MSPOWERPOINT],
  253. // Image files
  254. 'jpg' => ['iconClass' => 'mb-icon--image', 'type' => self::FILE_TYPE_IMAGE],
  255. 'jpeg' => ['iconClass' => 'mb-icon--image', 'type' => self::FILE_TYPE_IMAGE],
  256. 'tiff' => ['iconClass' => 'mb-icon--image', 'type' => self::FILE_TYPE_IMAGE],
  257. 'tif' => ['iconClass' => 'mb-icon--image', 'type' => self::FILE_TYPE_IMAGE],
  258. 'png' => ['iconClass' => 'mb-icon--image', 'type' => self::FILE_TYPE_IMAGE],
  260. // Html/Text files
  261. 'html' => ['iconClass' => 'mb-icon--html', 'type' => self::FILE_TYPE_TEXT_HTML],
  262. 'htm' => ['iconClass' => 'mb-icon--html', 'type' => self::FILE_TYPE_TEXT_HTML],
  263. 'txt' => ['iconClass' => 'mb-icon--text', 'type' => self::FILE_TYPE_TEXT_HTML],
  265. // eml/msg files
  266. 'eml' => ['iconClass' => 'mb-icon--mail', 'type' => self::FILE_TYPE_EML_MSG],
  267. 'msg' => ['iconClass' => 'mb-icon--mail', 'type' => self::FILE_TYPE_EML_MSG],
  269. ];
  271. /**
  272. * @var int
  273. *
  274. * @ORM\Column(name="id", type="integer")
  275. *
  276. * @ORM\Id
  277. *
  278. * @ORM\GeneratedValue(strategy="IDENTITY")
  279. */
  280. private $id;
  282. /**
  283. * @var \DateTime|null
  284. *
  285. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  286. */
  287. private $deletedAt;
  289. /**
  290. * @var string
  291. *
  292. * @ORM\Column(name="filename", type="string")
  293. */
  294. private $filename;
  296. /**
  297. * @var string
  298. *
  299. * @ORM\Column(name="original_filename", type="string")
  300. */
  301. private $original_filename;
  303. /**
  304. * @var string
  305. *
  306. * @ORM\Column(name="mime_type", type="string")
  307. */
  308. private $mime_type;
  310. /**
  311. * @var string
  312. *
  313. * @ORM\Column(name="filesize", type="string")
  314. */
  315. private $filesize;
  317. /**
  318. * @var int|null
  319. *
  320. * @ORM\Column(name="orthanc_storage_status", type="integer", nullable=true)
  321. */
  322. private $orthanc_storage_status;
  324. /**
  325. * @var string|null
  326. *
  327. * @ORM\Column(name="orthanc_store_response_id", type="string", length=255, nullable=true)
  328. */
  329. private $orthanc_store_response_id;
  331. /**
  332. * @var string|null
  333. *
  334. * @ORM\Column(name="orthanc_store_response_path", type="string", length=255, nullable=true)
  335. */
  336. private $orthanc_store_response_path;
  338. /**
  339. * @var string|null
  340. *
  341. * @ORM\Column(name="orthanc_store_response_status", type="string", length=255, nullable=true)
  342. */
  343. private $orthanc_store_response_status;
  345. /**
  346. * @var string|null
  347. *
  348. * @ORM\Column(name="orthanc_parent_series_id", type="string", length=255, nullable=true)
  349. */
  350. private $orthanc_parent_series_id;
  352. /**
  353. * Used as the primary determinant in ordering a sequence of dicom files
  354. *
  355. * @var int|null
  356. *
  357. * @ORM\Column(name="orthanc_instance_number", type="integer", nullable=true)
  358. */
  359. private $orthanc_instance_number;
  361. /**
  362. * @var string
  363. *
  364. * @ORM\Column(name="status", type="string")
  365. */
  366. private $status;
  368. /**
  369. * @var \DateTime
  370. *
  371. * @ORM\Column(name="created", type="datetime")
  372. *
  373. * @Gedmo\Timestampable(on="create")
  374. */
  375. private $created;
  377. /**
  378. * @var \DateTime
  379. *
  380. * @ORM\Column(name="updated", type="datetime")
  381. *
  382. * @Gedmo\Timestampable(on="update")
  383. */
  384. private $updated;
  386. /**
  387. * @var int|null
  388. *
  389. * @ORM\Column(name="convertedToSwfStatus", type="integer", nullable=true)
  390. */
  391. private $convertedToSwfStatus;
  393. /**
  394. * @var string|null
  395. *
  396. * @ORM\Column(name="nativeFilename", type="string", length=255, nullable=true)
  397. */
  398. private $nativeFilename;
  400. /**
  401. * @var string|null
  402. *
  403. * @ORM\Column(name="swfFilename", type="string", length=255, nullable=true)
  404. */
  405. private $swfFilename;
  407. /**
  408. * @var int|null
  409. *
  410. * @ORM\Column(name="convertedToOptimizedPdfStatus", type="integer", nullable=true)
  411. */
  412. private $convertedToOptimizedPdfStatus;
  414. /**
  415. * @var string|null
  416. *
  417. * @ORM\Column(name="optimizedPdfFilename", type="string", length=255, nullable=true)
  418. */
  419. private $optimizedPdfFilename;
  421. /**
  422. * @var int|null
  423. *
  424. * @ORM\Column(name="convertedToXodStatus", type="integer", nullable=true)
  425. */
  426. private $convertedToXodStatus;
  428. /**
  429. * @var string|null
  430. *
  431. * @ORM\Column(name="xodFilename", type="string", length=255, nullable=true)
  432. */
  433. private $xodFilename;
  435. /**
  436. * @var int|null
  437. *
  438. * @ORM\Column(name="convertedToWebAVStatus", type="integer", nullable=true)
  439. */
  440. private $convertedToWebAVStatus;
  442. /**
  443. * @var string|null
  444. *
  445. * @ORM\Column(name="webAVFilename", type="string", length=255, nullable=true)
  446. */
  447. private $webAVFilename;
  449. /**
  450. * @var int|null
  451. *
  452. * @ORM\Column(name="convertedToOcrStatus", type="integer", nullable=true)
  453. */
  454. private $convertedToOcrStatus;
  456. /**
  457. * @var string|null
  458. *
  459. * @ORM\Column(name="ocrFilename", type="string", length=255, nullable=true)
  460. */
  461. private $ocrFilename;
  463. /**
  464. * @var string|null
  465. *
  466. * @ORM\Column(name="ocrXodFilename", type="string", length=255, nullable=true)
  467. */
  468. private $ocrXodFilename;
  470. /**
  471. * @var string
  472. *
  473. * @ORM\Column(name="md5hash", type="string", length=40, nullable=false)
  474. */
  475. private $md5hash;
  477. /**
  478. * @var string|null
  479. *
  480. * @ORM\Column(name="documentTypeFamily", type="string", length=255, nullable=true)
  481. */
  482. private $documentTypeFamily;
  484. /**
  485. * @var Upload
  486. *
  487. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Upload")
  488. *
  489. * @ORM\JoinColumns({
  490. *
  491. * @ORM\JoinColumn(name="upload_id", referencedColumnName="id", unique=true)
  492. * })
  493. */
  494. private $upload;
  496. /**
  497. * @var DoctrineCollection
  498. *
  499. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\OrthancTransaction", mappedBy="document", cascade={"all"})
  500. */
  501. private $orthancTransactions;
  503. /**
  504. * @var Project
  505. *
  506. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Project", inversedBy="documents")
  507. *
  508. * @ORM\JoinColumns({
  509. *
  510. * @ORM\JoinColumn(name="project_id", referencedColumnName="id")
  511. * })
  512. */
  513. private $project;
  515. /**
  516. * @var DocumentType
  517. *
  518. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\DocumentType")
  519. *
  520. * @ORM\JoinColumns({
  521. *
  522. * @ORM\JoinColumn(name="documentType_id", referencedColumnName="id")
  523. * })
  524. */
  525. private $documentType;
  527. /**
  528. * @var User
  529. *
  530. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User", inversedBy="documents")
  531. *
  532. * @ORM\JoinColumns({
  533. *
  534. * @ORM\JoinColumn(name="creator_id", referencedColumnName="id", nullable=false)
  535. * })
  536. */
  537. private $creator;
  539. /**
  540. * @var DoctrineCollection
  541. *
  542. * TODO: This is the inverse side of the ManyToMany with Collection::$documents (owning side,
  543. * inversedBy="collections"). Doctrine only persists the join table from the owning side, and
  544. * Collection::addDocument()/removeDocument() only update Collection::$documents — they never
  545. * call $document->addCollection()/removeCollection() to keep this inverse side in sync.
  546. * As a result, calling $collection->addDocument($document) will NOT make the new Collection
  547. * show up in $document->getCollections() until the Document is reloaded (e.g. via
  548. * $em->clear() or a fresh query). Callers currently work around this by manually calling both
  549. * $collection->addDocument($document) and $document->addCollection($collection).
  550. * Fix: update Collection::addDocument()/removeDocument() to also sync this inverse side.
  551. *
  552. * @ORM\ManyToMany(targetEntity="MedBrief\MSR\Entity\Collection", mappedBy="documents")
  553. */
  554. private $collections;
  556. /**
  557. * @var string
  558. */
  559. private $orthanc_response_raw_json;
  561. /**
  562. * @var string
  563. */
  564. private $orthanc_response_id;
  566. /**
  567. * @var string
  568. */
  569. private $orthanc_response_path;
  571. /**
  572. * @var string
  573. */
  574. private $orthanc_response_status;
  576. /**
  577. * @var int
  578. */
  579. private $orthanc_submission_status;
  581. /**
  582. * The below properties are unmapped and used by the VichUploader bundle
  583. * when utilising File injection.
  584. */
  586. /**
  587. * @var string
  588. */
  589. private $nativeFile;
  591. /**
  592. * @var string
  593. */
  594. private $optimizedPdfFile;
  596. /**
  597. * @var string
  598. */
  599. private $swfFile;
  601. /**
  602. * @var string
  603. */
  604. private $webAVFile;
  606. /**
  607. * @var string
  608. */
  609. private $xodFile;
  611. /**
  612. * @var string
  613. */
  614. private $xodBlobFile;
  616. /**
  617. * @var string
  618. */
  619. private $ocrXodFile;
  621. /**
  622. * @var string
  623. */
  624. private $ocrXodBlobFile;
  626. /**
  627. * @var string
  628. */
  629. private $ocrFile;
  631. /**
  632. * @ORM\OneToOne(targetEntity=VirusScanItem::class, mappedBy="document")
  633. */
  634. private ?VirusScanItem $virusScanItem = null;
  636. /**
  637. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\SortingSessionStack", mappedBy="document")
  638. */
  639. private $sortingSessionStack;
  641. /**
  642. * @var bool|null
  643. *
  644. * @ORM\Column(name="hasCERIndex", type="boolean", nullable=true)
  645. */
  646. private ?bool $hasCERIndex = null;
  648. /**
  649. * Constructor
  650. */
  651. public function __construct()
  652. {
  653. $this->orthancTransactions = new \Doctrine\Common\Collections\ArrayCollection();
  654. $this->collections = new \Doctrine\Common\Collections\ArrayCollection();
  655. }
  657. public function __clone()
  658. {
  659. if ($this->id) {
  660. $this->project = null;
  661. $this->orthancTransactions = new \Doctrine\Common\Collections\ArrayCollection();
  662. $this->collections = new \Doctrine\Common\Collections\ArrayCollection();
  663. }
  664. }
  666. public function __toString()
  667. {
  668. return (string) $this->getFilename();
  669. }
  671. /**
  672. * Get id
  673. *
  674. * @return int
  675. */
  676. public function getId(): ?int
  677. {
  678. return $this->id;
  679. }
  681. /**
  682. * Set filename
  683. *
  684. * @param string $filename
  685. *
  686. * @return Document
  687. */
  688. public function setFilename($filename)
  689. {
  690. $this->filename = $filename;
  692. return $this;
  693. }
  695. /**
  696. * Get filename
  697. *
  698. * @return string
  699. */
  700. public function getFilename()
  701. {
  702. return $this->filename;
  703. }
  705. /**
  706. * Get filename with PDF extension.
  707. *
  708. * @return string
  709. */
  710. public function getFilenameAsPdf()
  711. {
  712. $filename = pathinfo($this->getFilename(), PATHINFO_FILENAME);
  713. if (isset($filename)) {
  714. return $filename . '.pdf';
  715. }
  717. return $this->filename . '.pdf';
  718. }
  720. /**
  721. * Set mime_type
  722. *
  723. * @param string $mimeType
  724. *
  725. * @return Document
  726. */
  727. public function setMimeType($mimeType)
  728. {
  729. $this->mime_type = $mimeType;
  731. return $this;
  732. }
  734. /**
  735. * Get mime_type
  736. *
  737. * @return string
  738. */
  739. public function getMimeType()
  740. {
  741. return $this->mime_type;
  742. }
  744. /**
  745. * Set filesize
  746. *
  747. * @param string $filesize
  748. *
  749. * @return Document
  750. */
  751. public function setFilesize($filesize)
  752. {
  753. $this->filesize = $filesize;
  755. return $this;
  756. }
  758. /**
  759. * Get filesize
  760. *
  761. * @return string
  762. */
  763. public function getFilesize()
  764. {
  765. return $this->filesize;
  766. }
  768. /**
  769. * Set status
  770. *
  771. * @param string $status
  772. *
  773. * @return Document
  774. */
  775. public function setStatus($status)
  776. {
  777. $this->status = $status;
  779. return $this;
  780. }
  782. /**
  783. * Get status
  784. *
  785. * @return string
  786. */
  787. public function getStatus()
  788. {
  789. return $this->status;
  790. }
  792. /**
  793. * Set created
  794. *
  795. * @param \DateTime $created
  796. *
  797. * @return Document
  798. */
  799. public function setCreated($created)
  800. {
  801. $this->created = $created;
  803. return $this;
  804. }
  806. /**
  807. * Get created
  808. *
  809. * @return \DateTime
  810. */
  811. public function getCreated()
  812. {
  813. return $this->created;
  814. }
  816. /**
  817. * Set updated
  818. *
  819. * @param \DateTime $updated
  820. *
  821. * @return Document
  822. */
  823. public function setUpdated($updated)
  824. {
  825. $this->updated = $updated;
  827. return $this;
  828. }
  830. /**
  831. * Get updated
  832. *
  833. * @return \DateTime
  834. */
  835. public function getUpdated()
  836. {
  837. return $this->updated;
  838. }
  840. /**
  841. * Set upload
  842. *
  843. * @param Upload $upload
  844. *
  845. * @return Document
  846. */
  847. public function setUpload(?Upload $upload = null)
  848. {
  849. $this->upload = $upload;
  851. return $this;
  852. }
  854. /**
  855. * Get upload
  856. *
  857. * @return Upload
  858. */
  859. public function getUpload()
  860. {
  861. return $this->upload;
  862. }
  864. /**
  865. * Set project
  866. *
  867. * @param Project $project
  868. *
  869. * @return Document
  870. */
  871. public function setProject(?Project $project = null)
  872. {
  873. $this->project = $project;
  875. return $this;
  876. }
  878. /**
  879. * Get project
  880. *
  881. * @return Project
  882. */
  883. public function getProject()
  884. {
  885. return $this->project;
  886. }
  888. /**
  889. * Set documentType
  890. *
  891. * @param DocumentType $documentType
  892. *
  893. * @return Document
  894. */
  895. public function setDocumentType(?DocumentType $documentType = null)
  896. {
  897. $this->documentType = $documentType;
  899. return $this;
  900. }
  902. /**
  903. * Get documentType
  904. *
  905. * @return DocumentType
  906. */
  907. public function getDocumentType()
  908. {
  909. return $this->documentType;
  910. }
  912. /**
  913. * Add collections
  914. *
  915. * @param \MedBrief\MSR\Entity\Collection $collections
  916. *
  917. * @return Document
  918. */
  919. public function addCollection(Collection $collections)
  920. {
  921. $this->collections[] = $collections;
  923. return $this;
  924. }
  926. /**
  927. * Remove collections
  928. *
  929. * @param \MedBrief\MSR\Entity\Collection $collections
  930. */
  931. public function removeCollection(Collection $collections)
  932. {
  933. $this->collections->removeElement($collections);
  934. }
  936. /**
  937. * Get collections
  938. *
  939. * Note: not a real union - DoctrineCollection is the actual runtime return type; Collection[]
  940. * is a conventional IDE/static-analysis hint indicating the element type when iterated.
  941. *
  942. * @return DoctrineCollection|Collection[]
  943. */
  944. public function getCollections()
  945. {
  946. return $this->collections;
  947. }
  949. /**
  950. * Set creator
  951. *
  952. * @param User $creator
  953. *
  954. * @return Document
  955. */
  956. public function setCreator(User $creator)
  957. {
  958. $this->creator = $creator;
  960. return $this;
  961. }
  963. /**
  964. * Get creator
  965. *
  966. * @return User
  967. */
  968. public function getCreator()
  969. {
  970. return $this->creator;
  971. }
  973. /**
  974. * Set nativeFilename
  975. *
  976. * @param string $nativeFilename
  977. *
  978. * @return Document
  979. */
  980. public function setNativeFilename($nativeFilename)
  981. {
  982. $this->nativeFilename = $nativeFilename;
  984. return $this;
  985. }
  987. /**
  988. * Get nativeFilename
  989. *
  990. * @return string
  991. */
  992. public function getNativeFilename()
  993. {
  994. return $this->nativeFilename;
  995. }
  997. /**
  998. * Set nativeFile
  999. *
  1000. * @param string $nativeFile
  1001. *
  1002. * @return Document
  1003. */
  1004. public function setNativeFile($nativeFile)
  1005. {
  1006. $this->nativeFile = $nativeFile;
  1008. return $this;
  1009. }
  1011. /**
  1012. * Get nativeFile
  1013. *
  1014. * @return string
  1015. */
  1016. public function getNativeFile()
  1017. {
  1018. return $this->nativeFile;
  1019. }
  1021. /**
  1022. * Returns an array of this documents data
  1023. *
  1024. * @return array
  1025. *
  1026. *@todo add more data Of maybe even just use the symfony serializer component
  1027. *
  1028. */
  1029. public function jsonSerialize(): mixed
  1030. {
  1031. return [
  1032. 'created' => $this->getCreated()->format('j F Y, H:ia'),
  1033. 'filename' => $this->getFilename(),
  1034. 'filesize' => number_format($this->getFilesize(), 0),
  1035. ];
  1036. }
  1038. /**
  1039. * Given the orthancTransaction (which is assumed to be of type STORE)
  1040. * We update the appropriate values on this Document to indicate the various
  1041. * orthanc data returned by the storage transaction
  1042. *
  1043. * @param OrthancTransaction $orthancTransaction
  1044. */
  1045. public function processOrthancStoreTransaction(OrthancTransaction $orthancTransaction)
  1046. {
  1047. // first - set the submissions status to pending at the outset
  1048. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_PENDING);
  1050. // if the given transaction wasn't a success, the storage status of this
  1051. // document is automatically also a fail
  1052. if ($orthancTransaction->getTransactionStatus() != OrthancTransaction::TRANSACTION_STATUS_SUCCESS) {
  1053. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_FAILED);
  1054. return false;
  1055. }
  1057. // if we get here, then everything is in order!
  1058. $jsonObject = json_decode($orthancTransaction->getTransactionResponse());
  1060. // set the individual values on the document
  1061. $orthancStoreResponseId = $jsonObject->ID;
  1062. $orthancStoreResponsePath = $jsonObject->Path;
  1063. $orthancStoreResponseStatus = $jsonObject->Status;
  1065. $this->setOrthancStoreResponseId($orthancStoreResponseId);
  1066. $this->setOrthancStoreResponsePath($orthancStoreResponsePath);
  1067. $this->setOrthancStoreResponseStatus($orthancStoreResponseStatus);
  1069. // set the status as successful
  1070. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_STORED);
  1071. }
  1073. /**
  1074. * Given the orthancTransaction (which is assumed to be of type INSTANCE_DETAILS) we
  1075. * update the parent series id of this document
  1076. *
  1077. * @param OrthancTransaction $orthancTransaction
  1078. *
  1079. * @return void
  1080. */
  1081. public function processOrthancInstanceDetailsTransaction(OrthancTransaction $orthancTransaction): void
  1082. {
  1083. if ($orthancTransaction->getTransactionStatus() == OrthancTransaction::TRANSACTION_STATUS_SUCCESS) {
  1084. $jsonObject = json_decode($orthancTransaction->getTransactionResponse());
  1086. $this->setOrthancParentSeriesId($jsonObject->ParentSeries);
  1088. // we anticipate that InstanceNumbers from Othanc will always be
  1089. // integers (we hope) we cast them to Ints because our database
  1090. // field is an integer. We have to use an integer field for
  1091. // ordering purposes (varchar doesnt order correctly)
  1092. if (isset($jsonObject->MainDicomTags) && isset($jsonObject->MainDicomTags->InstanceNumber)) {
  1093. $this->setOrthancInstanceNumber(intval($jsonObject->MainDicomTags->InstanceNumber));
  1094. }
  1095. }
  1097. }
  1099. /**
  1100. * Given the orthancTransaction (which is assumed to be of type DELETE) we
  1101. * update the orthancStorage status of this document
  1102. *
  1103. * @param OrthancTransaction $orthancTransaction
  1104. *
  1105. * @return bool
  1106. */
  1107. public function processOrthancDeleteTransaction(OrthancTransaction $orthancTransaction): bool
  1108. {
  1109. // first - set the submissions status to pending at the outset
  1110. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_PENDING);
  1112. // if the transaction status is not SUCCESS then set this status as FAILED
  1113. if ($orthancTransaction->getTransactionStatus() != OrthancTransaction::TRANSACTION_STATUS_SUCCESS) {
  1114. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_FAILED);
  1115. return false;
  1116. }
  1118. // set the status as successful
  1119. $this->setOrthancStorageStatus(self::ORTHANC_STORAGE_STATUS_DELETED);
  1120. return true;
  1121. }
  1123. /**
  1124. * Add orthancTransaction. When a orthancTransaction is assigned to this
  1125. * Document using this function, then the associated orthanc values on this
  1126. * Document will be updated with th assumption that this transaction is the
  1127. * latest one to have run on the document
  1128. *
  1129. * @param OrthancTransaction $orthancTransaction
  1130. *
  1131. * @return Document
  1132. */
  1133. public function addOrthancTransaction(OrthancTransaction $orthancTransaction)
  1134. {
  1135. $this->orthancTransactions[] = $orthancTransaction;
  1137. // based on the type of the transaction, we run the appropriate function
  1138. // on this document
  1139. switch ($orthancTransaction->getType()) {
  1140. case OrthancTransaction::TYPE_STORE_INSTANCE:
  1141. $this->processOrthancStoreTransaction($orthancTransaction);
  1142. break;
  1143. case OrthancTransaction::TYPE_DELETE_INSTANCE:
  1144. $this->processOrthancDeleteTransaction($orthancTransaction);
  1145. break;
  1146. case OrthancTransaction::TYPE_INSTANCE_DETAILS:
  1147. $this->processOrthancInstanceDetailsTransaction($orthancTransaction);
  1148. break;
  1149. default:
  1150. throw new \Exception('Invalid OrthancTransaction Type: ' . $orthancTransaction->getType());
  1151. }
  1153. return $this;
  1154. }
  1156. /**
  1157. * Remove orthancTransaction
  1158. *
  1159. * @param OrthancTransaction $orthancTransaction
  1160. */
  1161. public function removeOrthancTransaction(OrthancTransaction $orthancTransaction)
  1162. {
  1163. $this->orthancTransactions->removeElement($orthancTransaction);
  1164. }
  1166. /**
  1167. * Get orthancTransactions
  1168. *
  1169. * @return DoctrineCollection
  1170. */
  1171. public function getOrthancTransactions()
  1172. {
  1173. return $this->orthancTransactions;
  1174. }
  1176. /**
  1177. * Set orthancStorageStatus
  1178. *
  1179. * @param int $orthancStorageStatus
  1180. *
  1181. * @return Document
  1182. */
  1183. public function setOrthancStorageStatus($orthancStorageStatus)
  1184. {
  1185. $this->orthanc_storage_status = $orthancStorageStatus;
  1187. return $this;
  1188. }
  1190. /**
  1191. * Get orthancStorageStatus
  1192. *
  1193. * @return int
  1194. */
  1195. public function getOrthancStorageStatus()
  1196. {
  1197. return $this->orthanc_storage_status;
  1198. }
  1200. /**
  1201. * Set orthancStoreResponseId
  1202. *
  1203. * @param string $orthancStoreResponseId
  1204. *
  1205. * @return Document
  1206. */
  1207. public function setOrthancStoreResponseId($orthancStoreResponseId)
  1208. {
  1209. $this->orthanc_store_response_id = $orthancStoreResponseId;
  1211. return $this;
  1212. }
  1214. /**
  1215. * Get orthancStoreResponseId
  1216. *
  1217. * @return string
  1218. */
  1219. public function getOrthancStoreResponseId()
  1220. {
  1221. return $this->orthanc_store_response_id;
  1222. }
  1224. /**
  1225. * Set orthancStoreResponsePath
  1226. *
  1227. * @param string $orthancStoreResponsePath
  1228. *
  1229. * @return Document
  1230. */
  1231. public function setOrthancStoreResponsePath($orthancStoreResponsePath)
  1232. {
  1233. $this->orthanc_store_response_path = $orthancStoreResponsePath;
  1235. return $this;
  1236. }
  1238. /**
  1239. * Get orthancStoreResponsePath
  1240. *
  1241. * @return string
  1242. */
  1243. public function getOrthancStoreResponsePath()
  1244. {
  1245. return $this->orthanc_store_response_path;
  1246. }
  1248. /**
  1249. * Set orthancStoreResponseStatus
  1250. *
  1251. * @param string $orthancStoreResponseStatus
  1252. *
  1253. * @return Document
  1254. */
  1255. public function setOrthancStoreResponseStatus($orthancStoreResponseStatus)
  1256. {
  1257. $this->orthanc_store_response_status = $orthancStoreResponseStatus;
  1259. return $this;
  1260. }
  1262. /**
  1263. * Get orthancStoreResponseStatus
  1264. *
  1265. * @return string
  1266. */
  1267. public function getOrthancStoreResponseStatus()
  1268. {
  1269. return $this->orthanc_store_response_status;
  1270. }
  1272. /**
  1273. * Set deletedAt
  1274. *
  1275. * @param \DateTime $deletedAt
  1276. *
  1277. * @return Document
  1278. */
  1279. public function setDeletedAt($deletedAt)
  1280. {
  1281. $this->deletedAt = $deletedAt;
  1283. return $this;
  1284. }
  1286. /**
  1287. * Get deletedAt
  1288. *
  1289. * @return \DateTime
  1290. */
  1291. public function getDeletedAt()
  1292. {
  1293. return $this->deletedAt;
  1294. }
  1296. /**
  1297. * Set orthancParentSeriesId
  1298. *
  1299. * @param string $orthancParentSeriesId
  1300. *
  1301. * @return Document
  1302. */
  1303. public function setOrthancParentSeriesId($orthancParentSeriesId)
  1304. {
  1305. $this->orthanc_parent_series_id = $orthancParentSeriesId;
  1307. return $this;
  1308. }
  1310. /**
  1311. * Get orthancParentSeriesId
  1312. *
  1313. * @return string
  1314. */
  1315. public function getOrthancParentSeriesId()
  1316. {
  1317. return $this->orthanc_parent_series_id;
  1318. }
  1320. /**
  1321. * Set md5hash
  1322. *
  1323. * @param string $md5hash
  1324. *
  1325. * @return Document
  1326. */
  1327. public function setMd5hash($md5hash)
  1328. {
  1329. $this->md5hash = $md5hash;
  1331. return $this;
  1332. }
  1334. /**
  1335. * Get md5hash
  1336. *
  1337. * @return string
  1338. */
  1339. public function getMd5hash()
  1340. {
  1341. return $this->md5hash;
  1342. }
  1344. /**
  1345. * Returns this Document as a jsTree formatted node
  1346. *
  1347. * @param string $replacementNodeText
  1348. * @param array $additionalLiAttributes
  1349. * @param bool $sorted
  1350. * @param bool $isCerIndex
  1351. *
  1352. * @return array
  1353. */
  1354. public function getJsTreeFormattedNode($replacementNodeText = null, $additionalLiAttributes = [], bool $sorted = false, bool $isCerIndex = false)
  1355. {
  1356. if ($this->isWebAV()) {
  1357. $dataConversionProgress = $this->getConvertedToWebAVStatusLabel(true);
  1358. } else {
  1359. $dataConversionProgress = $this->getConvertedToXodStatusLabel(true);
  1360. }
  1362. $node = [
  1363. 'text' => $replacementNodeText ?: $this->getFilename(),
  1364. 'type' => 'file',
  1365. 'icon' => ' mb-icon ' . $this->getIconClassName(),
  1366. 'valid_children' => null,
  1367. 'li_attr' => [
  1368. 'data-document-id' => $this->getId(),
  1369. 'data-native-filename' => $this->getNativeFilename(),
  1370. 'data-controller' => 'fullrow-foldertree',
  1371. 'data-creator-id' => $this->getCreator() ? $this->getCreator()->getId() : '',
  1372. 'data-conversion-progress' => $dataConversionProgress,
  1373. 'data-document-type-family' => $this->getDocumentTypeFamily(),
  1374. 'data-document-mime-type' => $this->getMimeType(),
  1375. 'data-sorted' => $sorted,
  1376. 'data-cer-index' => $isCerIndex,
  1377. 'data-has-cer-index' => $this->hasCERIndex(),
  1378. ],
  1379. ];
  1381. foreach ($additionalLiAttributes as $key => $value) {
  1382. $node['li_attr'][$key] = $value;
  1383. }
  1385. return $node;
  1386. }
  1388. /**
  1389. * Set originalFilename
  1390. *
  1391. * @param string $originalFilename
  1392. *
  1393. * @return Document
  1394. */
  1395. public function setOriginalFilename($originalFilename)
  1396. {
  1397. $this->original_filename = $originalFilename;
  1399. return $this;
  1400. }
  1402. /**
  1403. * Get originalFilename
  1404. *
  1405. * @return string
  1406. */
  1407. public function getOriginalFilename()
  1408. {
  1409. return $this->original_filename;
  1410. }
  1412. /**
  1413. * Set swfFilename
  1414. *
  1415. * @param string $swfFilename
  1416. *
  1417. * @return Document
  1418. */
  1419. public function setSwfFilename($swfFilename)
  1420. {
  1421. $this->swfFilename = $swfFilename;
  1423. return $this;
  1424. }
  1426. /**
  1427. * Get swfFilename
  1428. *
  1429. * @return string
  1430. */
  1431. public function getSwfFilename()
  1432. {
  1433. return $this->swfFilename;
  1434. }
  1436. /**
  1437. * Set swfFile
  1438. *
  1439. * @param string $swfFile
  1440. *
  1441. * @return Document
  1442. */
  1443. public function setSwfFile($swfFile)
  1444. {
  1445. $this->swfFile = $swfFile;
  1447. return $this;
  1448. }
  1450. /**
  1451. * Get swfFile
  1452. *
  1453. * @return string
  1454. */
  1455. public function getSwfFile()
  1456. {
  1457. return $this->swfFile;
  1458. }
  1460. /**
  1461. * Set convertedToSwfStatus
  1462. *
  1463. * @param string $convertedToSwfStatus
  1464. *
  1465. * @return Document
  1466. */
  1467. public function setConvertedToSwfStatus($convertedToSwfStatus)
  1468. {
  1469. $this->convertedToSwfStatus = $convertedToSwfStatus;
  1471. return $this;
  1472. }
  1474. /**
  1475. * Get convertedToSwfStatus
  1476. *
  1477. * @return string
  1478. */
  1479. public function getConvertedToSwfStatus()
  1480. {
  1481. return $this->convertedToSwfStatus;
  1482. }
  1484. /**
  1485. * Set orthancInstanceNumber
  1486. *
  1487. * @param string $orthancInstanceNumber
  1488. *
  1489. * @return Document
  1490. */
  1491. public function setOrthancInstanceNumber($orthancInstanceNumber)
  1492. {
  1493. $this->orthanc_instance_number = $orthancInstanceNumber;
  1495. return $this;
  1496. }
  1498. /**
  1499. * Get orthancInstanceNumber
  1500. *
  1501. * @return string
  1502. */
  1503. public function getOrthancInstanceNumber()
  1504. {
  1505. return $this->orthanc_instance_number;
  1506. }
  1508. // @Todo remove getIconClassName function once all aspects of font-awesome has been removed.
  1509. /**
  1510. * returns fa icon class
  1511. */
  1512. public function getIconClassName()
  1513. {
  1514. // determine file extension
  1515. $extension = strtolower(pathinfo($this->getFilename(), PATHINFO_EXTENSION));
  1516. // If the file extension on the filename is empty, check the native filename.
  1517. if (!$extension) {
  1518. $extension = strtolower(pathinfo($this->getNativeFilename(), PATHINFO_EXTENSION));
  1519. }
  1520. return 'mb-icon ' . (array_key_exists($extension, self::$fileIcons) ? self::$fileIcons[$extension]['iconClass'] : 'mb-icon--file');
  1521. }
  1523. /**
  1524. * determines the file type using a convoluted route of checking the file's
  1525. * fa icon class.
  1526. */
  1527. public function getFileFamilyType()
  1528. {
  1529. // determine file extension
  1530. $extension = strtolower(pathinfo($this->getFilename(), PATHINFO_EXTENSION));
  1531. // If the file extension on the filename is empty, check the native filename.
  1532. if (!$extension) {
  1533. $extension = strtolower(pathinfo($this->getNativeFilename(), PATHINFO_EXTENSION));
  1534. }
  1535. return self::guessFileFamilyType($extension);
  1536. }
  1538. /**
  1539. * Guesses the fileFamilyType fiven an extension.
  1540. *
  1541. * @param string $extension
  1542. *
  1543. * @return string
  1544. */
  1545. public static function guessFileFamilyType($extension)
  1546. {
  1547. return (array_key_exists($extension, self::$fileIcons) ? self::$fileIcons[$extension]['type'] : 'false');
  1548. }
  1550. /**
  1551. * Helper function to return if the file is a pdf.
  1552. */
  1553. public function isPdf()
  1554. {
  1555. return $this->getFileFamilyType() === self::FILE_TYPE_PDF;
  1556. }
  1558. /**
  1559. * Helper function to return true if the file is a Image.
  1560. */
  1561. public function isImage()
  1562. {
  1563. return $this->getFileFamilyType() === self::FILE_TYPE_IMAGE;
  1564. }
  1566. /**
  1567. * Helper function to return true if the file is Text or Html.
  1568. */
  1569. public function isTextOrHtml()
  1570. {
  1571. return $this->getFileFamilyType() === self::FILE_TYPE_TEXT_HTML;
  1572. }
  1574. /**
  1575. * Helper function to return true if the file is Msg or Eml.
  1576. */
  1577. public function isEmlOrMsg()
  1578. {
  1579. return $this->getFileFamilyType() === self::FILE_TYPE_EML_MSG;
  1580. }
  1582. /**
  1583. * Helper function to return if the file is an ms office document.
  1584. */
  1585. public function isMSOffice()
  1586. {
  1587. return in_array($this->getFileFamilyType(), [
  1588. self::FILE_TYPE_MSWORD,
  1589. self::FILE_TYPE_MSEXCEL,
  1590. self::FILE_TYPE_MSPOWERPOINT,
  1591. ]);
  1592. }
  1594. /**
  1595. * Helper function to return if the file is a WebAV.
  1596. */
  1597. public function isWebAV()
  1598. {
  1599. return in_array($this->getFileFamilyType(), [self::FILE_TYPE_AUDIO, self::FILE_TYPE_VIDEO]);
  1600. }
  1602. /**
  1603. * Returns true if we support viewing of this document type.
  1604. *
  1605. * @return bool
  1606. */
  1607. public function supportsViewing()
  1608. {
  1609. $allowedTypes = self::getSupportedViewingTypes();
  1611. return in_array($this->getDocumentTypeFamily(), $allowedTypes);
  1612. }
  1614. /**
  1615. * Returns true if we support webAV playback of this document type
  1616. *
  1617. * @return bool
  1618. */
  1619. public function supportsWebAVPlayback()
  1620. {
  1621. $allowedTypes = self::getSupportedWebAVPlaybackTypes();
  1622. $allowedMimeTypes = self::getSupportedWebAVMimeTypes();
  1624. return
  1625. in_array($this->getDocumentTypeFamily(), $allowedTypes)
  1626. && in_array($this->getMimeType(), $allowedMimeTypes);
  1627. }
  1629. /**
  1630. * Returns the documentFamilyTypes we support for viewing.
  1631. *
  1632. * @return array
  1633. */
  1634. public static function getSupportedViewingTypes()
  1635. {
  1636. return [
  1637. self::FILE_TYPE_MSEXCEL,
  1638. self::FILE_TYPE_MSPOWERPOINT,
  1639. self::FILE_TYPE_MSWORD,
  1640. self::FILE_TYPE_PDF,
  1641. self::FILE_TYPE_IMAGE,
  1642. self::FILE_TYPE_TEXT_HTML,
  1643. self::FILE_TYPE_EML_MSG,
  1644. ];
  1645. }
  1647. /**
  1648. * Returns the documentFamilyTypes we support for viewing.
  1649. *
  1650. * @return array
  1651. */
  1652. public static function getSupportedWebAVPlaybackTypes()
  1653. {
  1654. return [
  1655. self::FILE_TYPE_AUDIO,
  1656. self::FILE_TYPE_VIDEO,
  1657. ];
  1658. }
  1660. /**
  1661. * Returns the mime types we support for playing webAV.
  1662. *
  1663. * @return array
  1664. */
  1665. public static function getSupportedWebAVMimeTypes()
  1666. {
  1667. return [
  1668. 'video/mp4',
  1669. //'video/dvr-ms', This is not the actual mime type for DVR, video/x-ms-asf is.
  1670. 'video/x-ms-asf',
  1671. 'audio/mpeg',
  1672. 'audio/x-wav',
  1673. ];
  1674. }
  1676. /**
  1677. * Set documentTypeFamily
  1678. *
  1679. * @param string $documentTypeFamily
  1680. *
  1681. * @return Document
  1682. */
  1683. public function setDocumentTypeFamily($documentTypeFamily)
  1684. {
  1685. $this->documentTypeFamily = $documentTypeFamily;
  1687. return $this;
  1688. }
  1690. /**
  1691. * Get documentTypeFamily
  1692. *
  1693. * @return string
  1694. */
  1695. public function getDocumentTypeFamily()
  1696. {
  1697. return $this->documentTypeFamily;
  1698. }
  1700. /**
  1701. * Set convertedToOptimizedPdfStatus
  1702. *
  1703. * @param int $convertedToOptimizedPdfStatus
  1704. *
  1705. * @return Document
  1706. */
  1707. public function setConvertedToOptimizedPdfStatus($convertedToOptimizedPdfStatus)
  1708. {
  1709. $this->convertedToOptimizedPdfStatus = $convertedToOptimizedPdfStatus;
  1711. return $this;
  1712. }
  1714. /**
  1715. * Get convertedToOptimizedPdfStatus
  1716. *
  1717. * @return int
  1718. */
  1719. public function getConvertedToOptimizedPdfStatus()
  1720. {
  1721. return $this->convertedToOptimizedPdfStatus;
  1722. }
  1724. /**
  1725. * Get ConvertedToOptimizedPdfStatus options
  1726. *
  1727. * @return array
  1728. */
  1729. public static function getConvertedToOptimizedPdfStatusOptions()
  1730. {
  1731. return [
  1732. self::CONVERSION_TO_OPTIMIZED_PDF_PENDING => 'Pending',
  1733. self::CONVERSION_TO_OPTIMIZED_PDF_COMPLETE => 'Complete',
  1734. self::CONVERSION_TO_OPTIMIZED_PDF_FAILED => 'Failed',
  1735. self::CONVERSION_TO_OPTIMIZED_PDF_CURRENT => 'Current',
  1736. self::CONVERSION_TO_OPTIMIZED_PDF_SKIPPED => 'Skipped',
  1737. ];
  1738. }
  1740. /**
  1741. * Get ConvertedToOptimizedPdfStatus label
  1742. *
  1743. * @param bool $markupFriendly - If the label returned should be markup friendly.
  1744. * Used for when you want to use the label as a CSS class.
  1745. *
  1746. * @return string
  1747. */
  1748. public function getConvertedToOptimizedPdfStatusLabel($markupFriendly = false)
  1749. {
  1750. $options = self::getConvertedToOptimizedPdfStatusOptions();
  1751. $label = $options[$this->getConvertedToOptimizedPdfStatus()] ?? '';
  1752. if ($markupFriendly) {
  1753. return strtolower(str_replace(' ', '-', $label));
  1754. }
  1755. return $label;
  1756. }
  1758. /**
  1759. * Returns true if the Document's ConvertedToOptimizedPdf status is Pending.
  1760. *
  1761. * @return bool
  1762. */
  1763. public function isConvertedToOptimizedPdfPending()
  1764. {
  1765. return $this->getConvertedToOptimizedPdfStatus() === self::CONVERSION_TO_OPTIMIZED_PDF_PENDING;
  1766. }
  1768. /**
  1769. * Returns true if the Document's ConvertedToOptimizedPdf status is Complete.
  1770. *
  1771. * @return bool
  1772. */
  1773. public function isConvertedToOptimizedPdfComplete()
  1774. {
  1775. return $this->getConvertedToOptimizedPdfStatus() === self::CONVERSION_TO_OPTIMIZED_PDF_COMPLETE;
  1776. }
  1778. /**
  1779. * Returns true if the Document's ConvertedToOptimizedPdf status is Failed.
  1780. *
  1781. * @return bool
  1782. */
  1783. public function isConvertedToOptimizedPdfFailed()
  1784. {
  1785. return $this->getConvertedToOptimizedPdfStatus() === self::CONVERSION_TO_OPTIMIZED_PDF_FAILED;
  1786. }
  1788. /**
  1789. * Returns true if the Document's ConvertedToOptimizedPdf status is Current.
  1790. *
  1791. * @return bool
  1792. */
  1793. public function isConvertedToOptimizedPdfCurrent()
  1794. {
  1795. return $this->getConvertedToOptimizedPdfStatus() === self::CONVERSION_TO_OPTIMIZED_PDF_CURRENT;
  1796. }
  1798. /**
  1799. * Returns true if the Document's ConvertedToOptimizedPdf status is Skipped.
  1800. *
  1801. * @return bool
  1802. */
  1803. public function isConvertedToOptimizedPdfSkipped()
  1804. {
  1805. return $this->getConvertedToOptimizedPdfStatus() === self::CONVERSION_TO_OPTIMIZED_PDF_SKIPPED;
  1806. }
  1808. /**
  1809. * Set optimizedPdfFilename
  1810. *
  1811. * @param string $optimizedPdfFilename
  1812. *
  1813. * @return Document
  1814. */
  1815. public function setOptimizedPdfFilename($optimizedPdfFilename)
  1816. {
  1817. $this->optimizedPdfFilename = $optimizedPdfFilename;
  1819. return $this;
  1820. }
  1822. /**
  1823. * Get optimizedPdfFilename
  1824. *
  1825. * @return string
  1826. */
  1827. public function getOptimizedPdfFilename()
  1828. {
  1829. return $this->optimizedPdfFilename;
  1830. }
  1832. /**
  1833. * Set optimizedPdfFile
  1834. *
  1835. * @param string $optimizedPdfFile
  1836. *
  1837. * @return Document
  1838. */
  1839. public function setOptimizedPdfFile($optimizedPdfFile)
  1840. {
  1841. $this->optimizedPdfFile = $optimizedPdfFile;
  1843. return $this;
  1844. }
  1846. /**
  1847. * Get optimizedPdfFile
  1848. *
  1849. * @return string
  1850. */
  1851. public function getOptimizedPdfFile()
  1852. {
  1853. return $this->optimizedPdfFile;
  1854. }
  1856. /**
  1857. * Set convertedToXodStatus
  1858. *
  1859. * @param int $convertedToXodStatus
  1860. *
  1861. * @return Document
  1862. */
  1863. public function setConvertedToXodStatus($convertedToXodStatus)
  1864. {
  1865. $this->convertedToXodStatus = $convertedToXodStatus;
  1867. return $this;
  1868. }
  1870. /**
  1871. * Get convertedToXodStatus
  1872. *
  1873. * @return int
  1874. */
  1875. public function getConvertedToXodStatus()
  1876. {
  1877. return $this->convertedToXodStatus;
  1878. }
  1880. /**
  1881. * Get ConvertedToXodStatus options
  1882. *
  1883. * @return array
  1884. */
  1885. public static function getConvertedToXodStatusOptions()
  1886. {
  1887. return [
  1888. self::CONVERSION_TO_XOD_PENDING => 'Pending',
  1889. self::CONVERSION_TO_XOD_COMPLETE => 'Complete',
  1890. self::CONVERSION_TO_XOD_FAILED => 'Failed',
  1891. self::CONVERSION_TO_XOD_CURRENT => 'Current',
  1892. self::CONVERSION_TO_XOD_SKIPPED => 'Skipped',
  1893. self::CONVERSION_TO_XOD_ENCRYPTED => 'Encrypted',
  1894. ];
  1895. }
  1897. /**
  1898. * Get ConvertedToXodStatus label
  1899. *
  1900. * @param bool $markupFriendly - If the label returned should be markup friendly.
  1901. * Used for when you want to use the label as a CSS class.
  1902. *
  1903. * @return string
  1904. */
  1905. public function getConvertedToXodStatusLabel($markupFriendly = false)
  1906. {
  1907. $options = self::getConvertedToXodStatusOptions();
  1908. $label = $options[$this->getConvertedToXodStatus()] ?? '';
  1909. if ($markupFriendly) {
  1910. return strtolower(str_replace(' ', '-', $label));
  1911. }
  1912. return $label;
  1913. }
  1915. /**
  1916. * Get ConvertedToWebAVStatus options
  1917. *
  1918. * @return array
  1919. */
  1920. public static function getConvertedToWebAVStatusOptions()
  1921. {
  1922. return [
  1923. self::CONVERSION_TO_WEBAV_PENDING => 'Pending',
  1924. self::CONVERSION_TO_WEBAV_COMPLETE => 'Complete',
  1925. self::CONVERSION_TO_WEBAV_FAILED => 'Failed',
  1926. self::CONVERSION_TO_WEBAV_CURRENT => 'Current',
  1927. self::CONVERSION_TO_WEBAV_SKIPPED => 'Skipped',
  1928. ];
  1929. }
  1931. /**
  1932. * Get ConvertedToWebAVStatus label
  1933. *
  1934. * @param bool $markupFriendly - If the label returned should be markup friendly.
  1935. * Used for when you want to use the label as a CSS class.
  1936. *
  1937. * @return string
  1938. */
  1939. public function getConvertedToWebAVStatusLabel($markupFriendly = false)
  1940. {
  1941. $options = self::getConvertedToWebAVStatusOptions();
  1942. $label = $options[$this->getConvertedToWebAVStatus()] ?? '';
  1943. if ($markupFriendly) {
  1944. return strtolower(str_replace(' ', '-', $label));
  1945. }
  1946. return $label;
  1947. }
  1949. /**
  1950. * Returns true if the Document's ConvertedToXod status is Pending.
  1951. *
  1952. * @return bool
  1953. */
  1954. public function isConvertedToXodPending()
  1955. {
  1956. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_PENDING;
  1957. }
  1959. /**
  1960. * Returns true if the Document's ConvertedToXod status is Complete.
  1961. *
  1962. * @return bool
  1963. */
  1964. public function isConvertedToXodComplete()
  1965. {
  1966. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_COMPLETE;
  1967. }
  1969. /**
  1970. * Returns true if the Document's ConvertedToXod status is Failed.
  1971. *
  1972. * @return bool
  1973. */
  1974. public function isConvertedToXodFailed()
  1975. {
  1976. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_FAILED;
  1977. }
  1979. /**
  1980. * Returns true if the Document's ConvertedToXod status is Current.
  1981. *
  1982. * @return bool
  1983. */
  1984. public function isConvertedToXodCurrent()
  1985. {
  1986. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_CURRENT;
  1987. }
  1989. /**
  1990. * Returns true if the Document's ConvertedToXod status is Skipped.
  1991. *
  1992. * @return bool
  1993. */
  1994. public function isConvertedToXodSkipped()
  1995. {
  1996. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_SKIPPED;
  1997. }
  1999. /**
  2000. * Returns true if the Document's ConvertedToXod status is Encrypted.
  2001. *
  2002. * @return bool
  2003. */
  2004. public function isConvertedToXodEncrypted()
  2005. {
  2006. return $this->getConvertedToXodStatus() === self::CONVERSION_TO_XOD_ENCRYPTED;
  2007. }
  2009. /**
  2010. * Set xodFilename
  2011. *
  2012. * @param string $xodFilename
  2013. *
  2014. * @return Document
  2015. */
  2016. public function setXodFilename($xodFilename)
  2017. {
  2018. $this->xodFilename = $xodFilename;
  2020. return $this;
  2021. }
  2023. /**
  2024. * Get xodFilename
  2025. *
  2026. * @return string
  2027. */
  2028. public function getXodFilename()
  2029. {
  2030. return $this->xodFilename;
  2031. }
  2033. /**
  2034. * Set xodFile
  2035. *
  2036. * @param string $xodFile
  2037. *
  2038. * @return Document
  2039. */
  2040. public function setXodFile($xodFile)
  2041. {
  2042. $this->xodFile = $xodFile;
  2044. return $this;
  2045. }
  2047. /**
  2048. * Set WebAVFile
  2049. *
  2050. * @param string $webAVFile
  2051. *
  2052. * @return Document
  2053. */
  2054. public function setWebAVFile($webAVFile)
  2055. {
  2056. $this->webAVFile = $webAVFile;
  2058. return $this;
  2059. }
  2061. /**
  2062. * Get WebAVFile
  2063. *
  2064. * @return string
  2065. */
  2066. public function getWebAVFile()
  2067. {
  2068. return $this->webAVFile;
  2069. }
  2071. /**
  2072. * Get xodFile
  2073. *
  2074. * @return string
  2075. */
  2076. public function getXodFile()
  2077. {
  2078. return $this->xodFile;
  2079. }
  2081. /**
  2082. * Set ocrFilename
  2083. *
  2084. * @param string $ocrFilename
  2085. *
  2086. * @return Document
  2087. */
  2088. public function setOcrFilename($ocrFilename)
  2089. {
  2090. $this->ocrFilename = $ocrFilename;
  2092. return $this;
  2093. }
  2095. /**
  2096. * Get ocrFilename
  2097. *
  2098. * @return string
  2099. */
  2100. public function getOcrFilename()
  2101. {
  2102. return $this->ocrFilename;
  2103. }
  2105. /**
  2106. * Set ocrFile
  2107. *
  2108. * @param string $ocrFile
  2109. *
  2110. * @return Document
  2111. */
  2112. public function setOcrFile($ocrFile)
  2113. {
  2114. $this->ocrFile = $ocrFile;
  2116. return $this;
  2117. }
  2119. /**
  2120. * Get ocrFile
  2121. *
  2122. * @return string
  2123. */
  2124. public function getOcrFile()
  2125. {
  2126. return $this->ocrFile;
  2127. }
  2129. /**
  2130. * Set convertedToOcrStatus
  2131. *
  2132. * @param int $convertedToOcrStatus
  2133. *
  2134. * @return Document
  2135. */
  2136. public function setConvertedToOcrStatus($convertedToOcrStatus)
  2137. {
  2138. $this->convertedToOcrStatus = $convertedToOcrStatus;
  2140. return $this;
  2141. }
  2143. /**
  2144. * Get convertedToOcrStatus
  2145. *
  2146. * @return int
  2147. */
  2148. public function getConvertedToOcrStatus()
  2149. {
  2150. return $this->convertedToOcrStatus;
  2151. }
  2153. /**
  2154. * Get ConvertedToOcrStatus options
  2155. *
  2156. * @return array
  2157. */
  2158. public static function getConvertedToOcrStatusOptions()
  2159. {
  2160. return [
  2161. self::CONVERSION_TO_OCR_PENDING => 'Pending',
  2162. self::CONVERSION_TO_OCR_COMPLETE => 'Complete',
  2163. self::CONVERSION_TO_OCR_FAILED => 'Failed',
  2164. self::CONVERSION_TO_OCR_CURRENT => 'In Progress',
  2165. self::CONVERSION_TO_OCR_SKIPPED => 'Skipped',
  2166. ];
  2167. }
  2169. /**
  2170. * Get ConvertedToOcrStatus label
  2171. *
  2172. * @param bool $markupFriendly - If the label returned should be markup friendly.
  2173. * Used for when you want to use the label as a CSS class.
  2174. *
  2175. * @return string
  2176. */
  2177. public function getConvertedToOcrStatusLabel($markupFriendly = false)
  2178. {
  2179. $options = self::getConvertedToOcrStatusOptions();
  2180. $label = $options[$this->getConvertedToOcrStatus()] ?? '';
  2181. if ($markupFriendly) {
  2182. return strtolower(str_replace(' ', '-', $label));
  2183. }
  2184. return $label;
  2185. }
  2187. /**
  2188. * Returns true if the Document's ConvertedToOcr status is Pending.
  2189. *
  2190. * @return bool
  2191. */
  2192. public function isConvertedToOcrPending()
  2193. {
  2194. return $this->getConvertedToOcrStatus() === self::CONVERSION_TO_OCR_PENDING;
  2195. }
  2197. /**
  2198. * Returns true if the Document's ConvertedToOcr status is Complete.
  2199. *
  2200. * @return bool
  2201. */
  2202. public function isConvertedToOcrComplete()
  2203. {
  2204. return $this->getConvertedToOcrStatus() === self::CONVERSION_TO_OCR_COMPLETE;
  2205. }
  2207. /**
  2208. * Returns true if the Document's ConvertedToOcr status is Failed.
  2209. *
  2210. * @return bool
  2211. */
  2212. public function isConvertedToOcrFailed()
  2213. {
  2214. return $this->getConvertedToOcrStatus() === self::CONVERSION_TO_OCR_FAILED;
  2215. }
  2217. /**
  2218. * Returns true if the Document's ConvertedToOcr status is Current.
  2219. *
  2220. * @return bool
  2221. */
  2222. public function isConvertedToOcrCurrent()
  2223. {
  2224. return $this->getConvertedToOcrStatus() === self::CONVERSION_TO_OCR_CURRENT;
  2225. }
  2227. /**
  2228. * Returns true if the Document's ConvertedToOcr status is Skipped.
  2229. *
  2230. * @return bool
  2231. */
  2232. public function isConvertedToOcrSkipped()
  2233. {
  2234. return $this->getConvertedToOcrStatus() === self::CONVERSION_TO_OCR_SKIPPED;
  2235. }
  2237. /**
  2238. * Returns true if we support OCR on this document type.
  2239. *
  2240. * @return bool
  2241. */
  2242. public function supportsOCR()
  2243. {
  2244. $allowedTypes = self::getSupportedTypesForOCR();
  2246. return in_array($this->getMimeType(), $allowedTypes);
  2247. }
  2249. /**
  2250. * Returns the MIME types we support for OCR.
  2251. *
  2252. * @return array
  2253. */
  2254. public static function getSupportedTypesForOCR()
  2255. {
  2256. return MimeTypes::PDF_MIME_TYPES;
  2257. }
  2259. /**
  2260. * Returns true if the Document can go ahead with OCR
  2261. *
  2262. * @return bool
  2263. */
  2264. public function ocrCanContinue()
  2265. {
  2266. return (!$this->isConvertedToOcrSkipped()
  2267. && !$this->isConvertedToOcrFailed()
  2268. && !$this->isConvertedToOcrCurrent()
  2269. );
  2270. }
  2272. /**
  2273. * Set ocrXodFilename
  2274. *
  2275. * @param string $ocrXodFilename
  2276. *
  2277. * @return Document
  2278. */
  2279. public function setOcrXodFilename($ocrXodFilename)
  2280. {
  2281. $this->ocrXodFilename = $ocrXodFilename;
  2283. return $this;
  2284. }
  2286. /**
  2287. * Get ocrXodFilename
  2288. *
  2289. * @return string|null
  2290. */
  2291. public function getOcrXodFilename()
  2292. {
  2293. return $this->ocrXodFilename;
  2294. }
  2296. /**
  2297. * Set ocrXodFile
  2298. *
  2299. * @param string $ocrXodFile
  2300. *
  2301. * @return Document
  2302. */
  2303. public function setOcrXodFile($ocrXodFile)
  2304. {
  2305. $this->ocrXodFile = $ocrXodFile;
  2307. return $this;
  2308. }
  2310. /**
  2311. * Get ocrXodFile
  2312. *
  2313. * @return string|null
  2314. */
  2315. public function getOcrXodFile()
  2316. {
  2317. return $this->ocrXodFile;
  2318. }
  2320. /**
  2321. * Set convertedToWebAVStatus.
  2322. *
  2323. * @param int|null $convertedToWebAVStatus
  2324. *
  2325. * @return Document
  2326. */
  2327. public function setConvertedToWebAVStatus($convertedToWebAVStatus = null)
  2328. {
  2329. $this->convertedToWebAVStatus = $convertedToWebAVStatus;
  2331. return $this;
  2332. }
  2334. /**
  2335. * Get convertedToWebAVStatus.
  2336. *
  2337. * @return int|null
  2338. */
  2339. public function getConvertedToWebAVStatus()
  2340. {
  2341. return $this->convertedToWebAVStatus;
  2342. }
  2344. /**
  2345. * Set webAVFilename.
  2346. *
  2347. * @param string|null $webAVFilename
  2348. *
  2349. * @return Document
  2350. */
  2351. public function setWebAVFilename($webAVFilename = null)
  2352. {
  2353. $this->webAVFilename = $webAVFilename;
  2355. return $this;
  2356. }
  2358. /**
  2359. * Get webAVFilename.
  2360. *
  2361. * @return string|null
  2362. */
  2363. public function getWebAVFilename()
  2364. {
  2365. return $this->webAVFilename;
  2366. }
  2368. /**
  2369. * Set xodBlobFile
  2370. *
  2371. * @param string $xodBlobFile
  2372. *
  2373. * @return Document
  2374. */
  2375. public function setXodBlobFile($xodBlobFile): self
  2376. {
  2377. $this->xodBlobFile = $xodBlobFile;
  2379. return $this;
  2380. }
  2382. /**
  2383. *
  2384. * @return VirusScanItem|null
  2385. */
  2386. public function getVirusScanItem(): ?VirusScanItem
  2387. {
  2388. return $this->virusScanItem;
  2389. }
  2391. /**
  2392. * @param VirusScanItem|null $virusScanItem
  2393. *
  2394. * @return self
  2395. */
  2396. public function setVirusScanItem(?VirusScanItem $virusScanItem): self
  2397. {
  2398. // unset the owning side of the relation if necessary
  2399. if ($virusScanItem === null && $this->virusScanItem !== null) {
  2400. $this->virusScanItem->setDocument(null);
  2401. }
  2403. // set the owning side of the relation if necessary
  2404. if ($virusScanItem !== null && $virusScanItem->getDocument() !== $this) {
  2405. $virusScanItem->setDocument($this);
  2406. }
  2408. $this->virusScanItem = $virusScanItem;
  2410. return $this;
  2411. }
  2413. /**
  2414. * @return SortingSessionStack|null
  2415. */
  2416. public function getSortingSessionStack()
  2417. {
  2418. return $this->sortingSessionStack;
  2419. }
  2421. /**
  2422. * @param SortingSessionStack|null $sortingSessionStack
  2423. *
  2424. * @return self
  2425. */
  2426. public function setSortingSessionStack($sortingSessionStack): self
  2427. {
  2428. if ($sortingSessionStack !== null && $sortingSessionStack->getDocument() !== $this) {
  2429. $sortingSessionStack->setDocument($this);
  2430. }
  2432. $this->sortingSessionStack = $sortingSessionStack;
  2434. return $this;
  2435. }
  2437. /**
  2438. * @param VirusScannerPathVisitorInterface $virusScannerPathVisitor
  2439. *
  2440. * @return VirusScannerVisitorInterface
  2441. */
  2442. public function acceptVirusScannerPathVisitor(VirusScannerPathVisitorInterface $virusScannerPathVisitor): string
  2443. {
  2444. return $virusScannerPathVisitor->visitDocument($this);
  2445. }
  2447. /**
  2448. * Get xodBlobFile
  2449. *
  2450. * @return string
  2451. */
  2452. public function getXodBlobFile()
  2453. {
  2454. return $this->xodBlobFile;
  2455. }
  2457. /**
  2458. * We return the xodFilename, as the file is mapped to the same filename field.
  2459. *
  2460. * @return string
  2461. */
  2462. public function getXodBlobFilename()
  2463. {
  2464. return $this->xodFilename;
  2465. }
  2467. /**
  2468. * Set ocrXodBlobFile
  2469. *
  2470. * @param string $ocrXodBlobFile
  2471. *
  2472. * @return Document
  2473. */
  2474. public function setOcrXodBlobFile($ocrXodBlobFile): self
  2475. {
  2476. $this->ocrXodBlobFile = $ocrXodBlobFile;
  2478. return $this;
  2479. }
  2481. /**
  2482. * Get ocrXodBlobFile
  2483. *
  2484. * @return string
  2485. */
  2486. public function getOcrXodBlobFile()
  2487. {
  2488. return $this->ocrXodBlobFile;
  2489. }
  2491. /**
  2492. * We return the xodFilename, as the file is mapped to the same filename field.
  2493. *
  2494. * @return string
  2495. */
  2496. public function getOcrXodBlobFilename()
  2497. {
  2498. return $this->ocrXodFilename;
  2499. }
  2501. /**
  2502. * Returns true if this Document has a CER Index, false otherwise.
  2503. *
  2504. * @return bool|null
  2505. */
  2506. public function hasCERIndex(): ?bool
  2507. {
  2508. return $this->hasCERIndex;
  2509. }
  2511. /**
  2512. * Sets the CER Index status for this Document.
  2513. *
  2514. * @param bool|null $hasCERIndex
  2515. *
  2516. * @return self
  2517. */
  2518. public function setHasCERIndex(?bool $hasCERIndex): self
  2519. {
  2520. $this->hasCERIndex = $hasCERIndex;
  2522. return $this;
  2523. }
  2525. /**
  2526. * Check if the document is part of the CER index.
  2527. *
  2528. * @param array $insightsIndexNativeFilenames
  2529. *
  2530. * @return bool
  2531. */
  2532. public function isCerIndex(array $insightsIndexNativeFilenames): bool
  2533. {
  2534. $nativeFilename = $this->getNativeFilename();
  2536. if ($nativeFilename === null || trim($nativeFilename) === '') {
  2537. return false;
  2538. }
  2540. return in_array($nativeFilename, $insightsIndexNativeFilenames, true);
  2541. }
  2542. }