class.tx_ter_api.php 68.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php
/**
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
/**
 * SOAP server for the TYPO3 Extension Repository
 *
 * @author    Robert Lemke <robert@typo3.org>
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

require_once(ExtensionManagementUtility::extPath('ter') . 'class.tx_ter_helper.php');

/**
 * TYPO3 Extension Repository, SOAP Server
 *
 * @author     Robert Lemke <robert@typo3.org>
 * @package    TYPO3
 * @subpackage tx_ter_soapserver
 */
class tx_ter_api
{

    /**
     * @var tx_ter_helper
     */
    protected $helperObj;

    /**
     * @var object
     */
    protected $parentObj;

    /**
     * @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
     */
    protected $cObj;

    /**
     * @var \TYPO3\CMS\Core\DataHandling\DataHandler
     */
    protected $tce;

    /**
     * 30MB Maximum upload size for extensions
     *
     * @var integer
     */
    protected $extensionMaxUploadSize = 31457280;

    /**
     * Constructor
     *
     * @param object $parentObj : Reference to parent object
     *
     * @access public
     */
    public function __construct($parentObj)
    {
        $this->helperObj = new tx_ter_helper ($parentObj);
        $this->parentObj = $parentObj;
        $this->cObj = $parentObj->cObj;
    }

    /*********************************************************
     *
     * PUBLIC API
     *
     *********************************************************/

    /**
     * Test method which just returns the given valued prepended with "pong"
     *
     * @param    string $value
     *
     * @return    string        $value prepended with "pong"
     * @access    public
     * @since     2.0.0
     */
    public function ping($value)
    {
        return 'pong' . $value;
    }

    /**
     * Checks for valid account data
     *
     * @param object $accountData : Username and passwords for auth check
     *
     * @return bool
     * @access public
     * @since 2.0.0
     */
    public function login($accountData)
    {
        return $this->helperObj->checkValidUser($accountData);
    }


    /**
     * Method for uploading an extension to the repository
     *
     * @param    object $accountData : Username and passwords for upload the extension
     * @param    object $extensionInfoData : The general extension information as received by the SOAP server
     * @param    array $filesData : The array of file data objects as received by the SOAP server
     *
     * @return    object        uploadExtensionResult object if upload was successful, otherwise an exception is thrown.
     * @throws tx_ter_exception
     * @access    public
     * @since     2.0.0
     */
    public function uploadExtension(
        $accountData,
        $extensionInfoData,
        $filesData
    ) {// When the extension has only one dependency, $extensionInfoData->technicalData->dependencies is a stdObj instead of an array
        // All following code will then fail, because it is tested if it was an array.
        // To make it work, we wrap the object into an array, so that the following code works as expected
        if (!empty($extensionInfoData->technicalData->dependencies) && is_object(
                $extensionInfoData->technicalData->dependencies
            )
        ) {
            $extensionInfoData->technicalData->dependencies = [$extensionInfoData->technicalData->dependencies];
        }
        $extensionKey = strtolower($extensionInfoData->extensionKey);
        if (TYPO3_DLOG) {
            GeneralUtility::devLog(
                'tx_ter_api->uploadExtension()', 'ter', 0,
                'Upload of extension ' . $extensionKey . ' (' . $extensionInfoData->version . ') by user ' . $accountData->username
            );
        }

        $uploadUserRecordArr = $this->helperObj->getValidUser($accountData);
        $extensionKeyRecordArr = $this->helperObj->getExtensionKeyRecord($extensionKey);
        if ($extensionKeyRecordArr == false) {
147
            throw new tx_ter_exception_notFound('Extension "' . $extensionKey . '" does not exist.', TX_TER_ERROR_UPLOADEXTENSION_EXTENSIONDOESNTEXIST);
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
        }
        if (strtolower($extensionKeyRecordArr['ownerusername']) !== strtolower(
                $accountData->username
            ) && $uploadUserRecordArr['admin'] !== true
        ) {
            throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_UPLOADEXTENSION_ACCESSDENIED);
        }

        // check for a valid version number
        if (preg_match('/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/', $extensionInfoData->version) == false) {
            throw new tx_ter_exception(
                'Your version number "' . htmlspecialchars(
                    $extensionInfoData->version
                ) . '" is invalid. Allowed are three numbers with maximum 999, e.g. "7.8.999".', 1429912029
            );
        }

        if ($this->checkUploadedExtensionVersionExistsInRepository($extensionInfoData)) {
            throw new tx_ter_exception_versionExists(
                'Version number ' . $extensionInfoData->version . ' already exists in repository.',
                TX_TER_ERROR_UPLOADEXTENSION_EXTENSIONVERSIONEXISTS
            );
        }

172
        if (($typo3DependencyCheck = $this->checkExtensionDependencyOnSupportedTypo3Version($extensionInfoData)) !== true && $uploadUserRecordArr['admin'] !== true) {
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
            switch ($typo3DependencyCheck) {
                case TX_TER_ERROR_UPLOADEXTENSION_TYPO3DEPENDENCYINCORRECT:
                    $message = 'Extension does not have a dependency for a supported version of TYPO3. See http://typo3.org/news/article/announcing-ter-cleanup-process/ for how to fix this.';
                    break;
                case TX_TER_ERROR_UPLOADEXTENSION_TYPO3DEPENDENCYCHECKFAILED:
                default:
                    $message = 'Check on dependency for a supported version of TYPO3 failed due to technical reasons';
                    break;
            }
            throw new tx_ter_exception_failedDependency($message, $typo3DependencyCheck);
        }

        $this->uploadExtension_writeExtensionAndIconFile($extensionInfoData, $filesData);
        $this->uploadExtension_writeExtensionInfoToDB($accountData, $extensionInfoData, $filesData);
        $this->helperObj->requestUpdateOfExtensionIndexFile();

        static::notifyExtensionVersionUpload($extensionInfoData);

        return [
            'resultCode' => TX_TER_RESULT_EXTENSIONSUCCESSFULLYUPLOADED,
            'resultMessages' => [
                'Please note that it might take a while (up to an hour) until your extension and the documentation appear on TYPO3.org.'
            ],
            'version' => $extensionInfoData->version,
        ];
    }

    /**
     * notify message queue server of uploaded extension
     *
     * has to be static because uploadExtensionWithoutSoap() is static
     *
     * @param $extensionInfoData
     * @return void
     */
    protected static function notifyExtensionVersionUpload($extensionInfoData)
    {
210
        $objectManager = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
        /** @var Tx_Amqp_Service_ProducerService $producerService */
        $producerService = $objectManager->get('Tx_Amqp_Service_ProducerService');

        $data = [
            'extensionKey' => $extensionInfoData->extensionKey,
            'version' => $extensionInfoData->version
        ];

        $producerService->sendToExchange($data, 'org.typo3.ter.version.upload');
    }

    /**
     * Method for manually uploading an extension to the repository
     *
     * @param string $username Username for upload the extension
     * @param object $extensionInfoData The general extension information
     * @param array $filesData The array of file data objects
     *
     * @return boolean TRUE on success
     */
    public static function uploadExtensionWithoutSoap($username, $extensionInfoData, $filesData)
    {
        // Make an instance of the api
        $extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['ter']);
        $dummyParentObject = (object)[
            'cObj' => GeneralUtility::makeInstance('tslib_cObj'),
            'extensionsPID' => $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_ter_pi1.']['pid'],
            'repositoryDir' => $extConf['repositoryDir'],
            'conf' => $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_ter_pi1.'],
        ];
        $instance = GeneralUtility::makeInstance('tx_ter_api', $dummyParentObject);
        $accountData = (object)['username' => $username];
        // Load extension
        $extensionKeyRecordArr = $instance->helperObj->getExtensionKeyRecord(strtolower($extensionInfoData->extensionKey));
        if ($extensionKeyRecordArr == false) {
            throw new tx_ter_exception_notFound('Extension does not exist.', TX_TER_ERROR_UPLOADEXTENSION_EXTENSIONDOESNTEXIST);
        }
        if (strtolower($extensionKeyRecordArr['ownerusername']) !== strtolower($username)) {
            throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_UPLOADEXTENSION_ACCESSDENIED);
        }

        // check for a valid version number
        if (preg_match('/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/', $extensionInfoData->version) == false) {
            throw new tx_ter_exception(
                'Your version number "' . htmlspecialchars(
                    $extensionInfoData->version
                ) . '" is invalid. Allowed are three numbers with maximum 999, e.g. "7.8.999".', 1429912029
            );
        }

        if (($typo3DependencyCheck = self::checkExtensionDependencyOnSupportedTypo3Version($extensionInfoData)) !== true) {
            switch ($typo3DependencyCheck) {
                case TX_TER_ERROR_UPLOADEXTENSION_TYPO3DEPENDENCYINCORRECT:
                    $message = 'Extension does not have a dependency for a supported version of TYPO3. See http://typo3.org/news/article/announcing-ter-cleanup-process/ for how to fix this.';
                    break;
                case TX_TER_ERROR_UPLOADEXTENSION_TYPO3DEPENDENCYCHECKFAILED:
                    // same behaviour as default
                default:
                    $message = 'Check on dependency for a supported version of TYPO3 failed due to technical reasons';
                    break;
            }
            throw new tx_ter_exception($message, $typo3DependencyCheck);
        }
        // Upload...
        $instance->uploadExtension_writeExtensionAndIconFile($extensionInfoData, $filesData);
        $instance->uploadExtension_writeExtensionInfoToDB($accountData, $extensionInfoData, $filesData);
        $instance->helperObj->requestUpdateOfExtensionIndexFile();

        static::notifyExtensionVersionUpload($extensionInfoData);

        return true;
    }

    /**
     * Method for deleting an extension version from the repository
     *
     * @param object $accountData : Username and passwords for upload the extension (admin account required)
     * @param string $extensionKey : Extension key of the extension version to delete
     * @param string $version : Version string of the extension version to delete
     *
     * @return object simpleResult object if extension could be deleted, otherwise an exception is thrown.
     * @throws tx_ter_exception_unauthorized
     * @throws tx_ter_exception_notFound
     * @access public
     * @since  2.0.1
     */
    public function deleteExtension($accountData, $extensionKey, $version)
    {
        if (TYPO3_DLOG) {
            GeneralUtility::devLog(
                'tx_ter_api->deleteExtension()', 'ter', 0,
                'Deletion of extension ' . $extensionKey . ' (' . $version . ') by user ' . $accountData->username
            );
        }

        $userRecordArr = $this->helperObj->getValidUser($accountData);
        if ($userRecordArr['admin'] !== true) {
            throw new tx_ter_exception_unauthorized(
                'Access denied. You must be administrator in order to delete extensions',
                TX_TER_ERROR_DELETEEXTENSION_ACCESS_DENIED
            );
        }
        $extensionKeyRecordArr = $this->helperObj->getExtensionKeyRecord($extensionKey);
        if ($extensionKeyRecordArr == false) {
            throw new tx_ter_exception_notFound(
                'Extension does not exist.', TX_TER_ERROR_DELETEEXTENSION_EXTENSIONDOESNTEXIST
            );
        }

        $this->deleteExtension_deleteFromDBAndRemoveFiles($extensionKey, $version);
        $this->helperObj->requestUpdateOfExtensionIndexFile();

        return [
            'resultCode' => TX_TER_RESULT_EXTENSIONSUCCESSFULLYDELETED,
            'resultMessages' => []
        ];
    }

    /**
     * Checks if an extension key already exists
     *
     * @param    object $accountData : A valid username and password
     * @param    string $extensionKey : The extension key to check
     *
     * @return    array simpleResult object if key could be checked, otherwise an exception is thrown.
     * @access    public
     * @since     2.0.0
     */
    public function checkExtensionKey($accountData, $extensionKey)
    {
        if ($this->checkExtensionKey_extensionKeyIsFormallyValid($extensionKey)) {
            $resultCode = $this->helperObj->extensionKeyIsAvailable(
                $extensionKey
            ) ? TX_TER_RESULT_EXTENSIONKEYDOESNOTEXIST : TX_TER_RESULT_EXTENSIONKEYALREADYEXISTS;
        } else {
            $resultCode = TX_TER_RESULT_EXTENSIONKEYNOTVALID;
        }

        return [
            'resultCode' => $resultCode,
            'resultMessages' => [],
        ];
    }

    /**
     * Registers an extension key
     *
     * @param    object $accountData : A valid username and password
     * @param    object $registerExtensionKeyData : The extension key and other information
     *
     * @return    array simpleResult object if key was registered, otherwise an exception is thrown.
     * @access    public
     * @since     2.0.0
     */
    public function registerExtensionKey($accountData, $registerExtensionKeyData)
    {
        if ($this->checkExtensionKey_extensionKeyIsFormallyValid($registerExtensionKeyData->extensionKey)) {
            if ($this->helperObj->extensionKeyIsAvailable($registerExtensionKeyData->extensionKey)) {
                $this->registerExtensionKey_writeExtensionKeyInfoToDB($accountData, $registerExtensionKeyData);
                $resultCode = TX_TER_RESULT_EXTENSIONKEYSUCCESSFULLYREGISTERED;
            } else {
                $this->notifyExtensionKeyRegistration($registerExtensionKeyData);
                $resultCode = TX_TER_RESULT_EXTENSIONKEYALREADYEXISTS;
            }
        } else {
            $resultCode = TX_TER_RESULT_EXTENSIONKEYNOTVALID;
        }

        return [
            'resultCode' => $resultCode,
            'resultMessages' => [],
        ];
    }

    /**
     * notify message queue server of registered extension key
     *
     * @param $registerExtensionKeyData
     * @return mixed
     */
    protected function notifyExtensionKeyRegistration($registerExtensionKeyData)
    {
393
        $objectManager = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
        /** @var Tx_Amqp_Service_ProducerService $producerService */
        $producerService = $objectManager->get('Tx_Amqp_Service_ProducerService');

        $data = [
            'extensionKey' => $registerExtensionKeyData->extensionKey,
        ];

        return $producerService->sendToExchange($data, 'org.typo3.ter.key.register');
    }

    /**
     * Returns a list of extension key records filtered by certain
     * criteria.
     *
     * @param    object $accountData : A valid username and password
     * @param    object $extensionKeyFilterOptions : Result will be filtered by fields set in these filter options
     *
     * @return    array getExtensionKeyRepsonse-object if key(s) could be fetched (might also be an empty result). An exception
     *     is thrown if an error ocurred.
     * @access    public
     * @since     2.0.0
     */
    public function getExtensionKeys($accountData, $extensionKeyFilterOptions)
    {
        $extensionKeyDataArr = [];

        $whereClause = 'pid=' . (int)$this->parentObj->extensionsPID;
        if (!empty($extensionKeyFilterOptions->username)) {
            $whereClause .= ' AND ownerusername = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                    $extensionKeyFilterOptions->username, 'tx_ter_extensionkeys'
                );
        }
        if (!empty($extensionKeyFilterOptions->title)) {
            $whereClause .= ' AND title = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                    $extensionKeyFilterOptions->title, 'tx_ter_extensionkeys'
                );
        }
        if (!empty($extensionKeyFilterOptions->description)) {
            $whereClause .= ' AND description = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                    $extensionKeyFilterOptions->description, 'tx_ter_extensionkeys'
                );
        }
        if (!empty($extensionKeyFilterOptions->extensionKey)) {
            $whereClause .= ' AND extensionkey = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                    $extensionKeyFilterOptions->extensionKey, 'tx_ter_extensionkeys'
                );
        }

        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'extensionkey,title,description,ownerusername', 'tx_ter_extensionkeys', $whereClause
        );

        if ($res) {
            while (($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))) {
                $extensionKeyDataArr[] = $row;
            }
            $resultCode = TX_TER_RESULT_GENERAL_OK;
        } else {
            throw new tx_ter_exception_internalServerError(
                'Database error while fetching extension keys.', TX_TER_ERROR_GENERAL_DATABASEERROR
            );
        }

        return [
            'simpleResult' => [
                'resultCode' => $resultCode,
                'resultMessages' => []
            ],
            'extensionKeyData' => $extensionKeyDataArr
        ];
    }

    /**
     * Deletes an extension key. Only possible if no uploaded versions exist.
     *
     * @param object $accountData : A valid username and password
     * @param string $extensionKey : The extension key to delete
     *
     * @return object simpleResponse-object. An exception is thrown if a fatal error ocurred.
     * @access public
     * @since  2.0.0
     * @throws tx_ter_exception_internalServerError
     * @throws tx_ter_exception_unauthorized
     */
    public function deleteExtensionKey($accountData, $extensionKey)
    {
        $userRecordArr = $this->helperObj->getValidUser($accountData);
        $extensionKeyRecordArr = $this->helperObj->getExtensionKeyRecord($extensionKey);

        if (is_array($extensionKeyRecordArr)) {
            if (strtolower($extensionKeyRecordArr['ownerusername']) != strtolower(
                    $accountData->username
                ) && $userRecordArr['admin'] !== true
            ) {
                throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_DELETEEXTENSIONKEY_ACCESSDENIED);
            }

            $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                'extensionkey', 'tx_ter_extensions', 'extensionkey=' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                    $extensionKey, 'tx_ter_extensions'
                ) . ' AND pid=' . (int)$this->parentObj->extensionsPID
            );

            if ($res) {
                if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) > 0) {
                    $resultCode = TX_TER_ERROR_DELETEEXTENSIONKEY_CANTDELETEBECAUSEVERSIONSEXIST;
                } else {
                    $res = $GLOBALS['TYPO3_DB']->exec_DELETEquery(
                        'tx_ter_extensionkeys', 'extensionkey=' . $GLOBALS['TYPO3_DB']->fullQuoteStr(
                            $extensionKey, 'tx_ter_extensions'
                        ) . ' AND pid=' . (int)$this->parentObj->extensionsPID
                    );
                    if (!$res) {
                        throw new tx_ter_exception_internalServerError(
                            'Database error while deleting extension key.', TX_TER_ERROR_GENERAL_DATABASEERROR
                        );
                    }

                    $resultCode = TX_TER_RESULT_GENERAL_OK;
                    $this->notifyExtensionKeyDelete($extensionKey);
                }
            } else {
                throw new tx_ter_exception_internalServerError(
                    'Database error while fetching versions.', TX_TER_ERROR_GENERAL_DATABASEERROR
                );
            }
        } else {
            $resultCode = TX_TER_ERROR_DELETEEXTENSIONKEY_KEYDOESNOTEXIST;
        }

        return [
            'resultCode' => $resultCode,
            'resultMessages' => []
        ];
    }

    /**
     * notify message queue server of deleted extension key
     *
     * @param $extensionKey
     * @return mixed
     */
    protected function notifyExtensionKeyDelete($extensionKey)
    {
538
        $objectManager = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
        /** @var Tx_Amqp_Service_ProducerService $producerService */
        $producerService = $objectManager->get('Tx_Amqp_Service_ProducerService');

        $data = [
            'extensionKey' => $extensionKey,
        ];

        $producerService->sendToExchange($data, 'org.typo3.ter.key.delete');
    }

    /**
     * Modifies an extension key.
     *
     * @param object $accountData : A valid username and password
     * @param object $modifyExtensionKeyData : Fields which should be changed, "extensionKey" is mandatory.
     *
     * @return object simpleResponse-object. An exception is thrown if a fatal error ocurred.
     * @access public
     * @since  2.0.0
     * @throws tx_ter_exception_unauthorized
     */
    public function modifyExtensionKey($accountData, $modifyExtensionKeyData)
    {
        $userRecordArr = $this->helperObj->getValidUser($accountData);
        $extensionKeyRecordArr = $this->helperObj->getExtensionKeyRecord($modifyExtensionKeyData->extensionKey);

        if (is_array($extensionKeyRecordArr)) {
            if (strtolower($extensionKeyRecordArr['ownerusername']) != strtolower(
                    $accountData->username
                ) && $userRecordArr['admin'] !== true
            ) {
                throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_MODIFYEXTENSIONKEY_ACCESSDENIED);
            }
            $resultCode = $this->modifyExtensionKey_writeModifiedKeyRecordIntoDB($accountData, $modifyExtensionKeyData);
            $this->helperObj->requestUpdateOfExtensionIndexFile();
        } else {
            $resultCode = TX_TER_ERROR_MODIFYEXTENSIONKEY_KEYDOESNOTEXIST;
        }

        return [
            'resultCode' => $resultCode,
            'resultMessages' => []
        ];
    }

    /**
     * Sets the review state of an extension version
     *
     * @param    object $accountData : A valid username and password
     * @param    object $setReviewStateData : The extension key, version number and the new review state (integer)
     *
     * @return    array simpleResponse-object. An exception is thrown if a fatal error ocurred.
     * @access    public
     * @throws    tx_ter_exception_internalServerError
     * @throws    tx_ter_exception_unauthorized
     * @since     2.0.0
     */
    public function setReviewState($accountData, $setReviewStateData)
    {
        $userRecordArr = $this->helperObj->getValidUser($accountData);
        $reviewersFrontendUsergroupUid = (int)$this->parentObj->conf['reviewersFrontendUsergroupUid'];

        if ($reviewersFrontendUsergroupUid == 0) {
            throw new tx_ter_exception_internalServerError(
                'Warning: No usergroup for reviewers has been defined on the server side. Aborting ...',
                TX_TER_ERROR_SETREVIEWSTATE_NOUSERGROUPDEFINED
            );
        }
        if (!GeneralUtility::inList($userRecordArr['usergroup'], $reviewersFrontendUsergroupUid)) {
            throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_SETREVIEWSTATE_ACCESSDENIED);
        }

        $this->setReviewState_writeNewStateIntoDB($setReviewStateData);

        //Regeneration of index file is currently deactived:
        //$this->helperObj->requestUpdateOfExtensionIndexFile();

        return [
            'resultCode' => TX_TER_RESULT_GENERAL_OK,
            'resultMessages' => []
        ];
    }

    /**
     * Increases the download counters of several extension version
     *
     * @param    object $accountData : A valid username and password
     * @param    object $extensionVersionsAndIncrementors : An array of extension keys, version numbers and the incrementor
     *
     * @return    object        simpleResponse-object. An exception is thrown if a fatal error ocurred.
     * @access    public
     * @throws    tx_ter_exception_internalServerError
     * @throws    tx_ter_exception_unauthorized
     * @since     2.0.0
     */
    public function increaseExtensionDownloadCounters($accountData, $extensionVersionsAndIncrementors)
    {
        $errorMessages = [];

        GeneralUtility::devLog(
            'DownloadCounter: Trying to increase extension download counters - user "' . $accountData->username . '" connected from IP "' . GeneralUtility::getIndpEnv(
                'REMOTE_ADDR'
            ) . '" - number of results: ' . count($extensionVersionsAndIncrementors->extensionVersionAndIncrementor),
            'tx_ter_api', 0
        );

        $userRecordArr = $this->helperObj->getValidUser($accountData);
        $mirrorsFrontendUsergroupUid = (int)$this->parentObj->conf['mirrorsFrontendUsergroupUid'];

        if ($mirrorsFrontendUsergroupUid == 0) {
            GeneralUtility::devLog(
                'DownloadCounter: No usergroup for mirrors has been defined on the server side. Aborting ...', 'tx_ter_api', 3
            );
            throw new tx_ter_exception_internalServerError(
                'Warning: No usergroup for mirrors has been defined on the server side. Aborting ...',
                TX_TER_ERROR_INCREASEEXTENSIONDOWNLOADCOUNTER_NOUSERGROUPDEFINED
            );
        }
        if (!GeneralUtility::inList($userRecordArr['usergroup'], $mirrorsFrontendUsergroupUid)) {
            GeneralUtility::devLog(
                'DownloadCounter: Access denied for user ' . $accountData->username, 'tx_ter_api', 3, $userRecordArr
            );
            throw new tx_ter_exception_unauthorized('Access denied.', TX_TER_ERROR_INCREASEEXTENSIONDOWNLOADCOUNTER_ACCESSDENIED);
        }

        $counter = 0;
        if (is_array($extensionVersionsAndIncrementors->extensionVersionAndIncrementor)) {
            foreach ($extensionVersionsAndIncrementors->extensionVersionAndIncrementor as $extensionVersionAndIncrementor) {
                try {
                    $this->increaseExtensionDownloadCounter_increaseCounterInDB($extensionVersionAndIncrementor);
                    $counter++;
                } catch (tx_ter_exception $exception) {
                    $errorMessages[] = '[' . $extensionVersionAndIncrementor->extensionKey . '][' . $extensionVersionAndIncrementor->version . '] ' . $exception->faultstring;
                }
            }
        } else {
            try {
                $extensionVersionAndIncrementor = $extensionVersionsAndIncrementors->extensionVersionAndIncrementor;
                $this->increaseExtensionDownloadCounter_increaseCounterInDB($extensionVersionAndIncrementor);
                $counter++;
            } catch (tx_ter_exception $exception) {
                $errorMessages[] = '[' . $extensionVersionAndIncrementor->extensionKey . '][' . $extensionVersionAndIncrementor->version . '] ' . $exception->faultstring;
            }
        }

        GeneralUtility::devLog(
            'DownloadCounter: Increased download counter for ' . $counter . ' extensions. User "' . $accountData->username . '".',
            'tx_ter_api', 0
        );
        // Update extension index file
        $this->helperObj->requestUpdateOfExtensionIndexFile();

        // Return results including list of error messages if any
        if (!empty($errorMessages)) {
            GeneralUtility::devLog(
                'DownloadCounter: Errors occured for user "' . $accountData->username . '".', 'tx_ter_api', 2, $errorMessages
            );
            $result = [
                'resultCode' => TX_TER_RESULT_ERRORS_OCCURRED,
                'resultMessages' => $errorMessages
            ];
        } else {
            GeneralUtility::devLog('DownloadCounter: Everything OK. User "' . $accountData->username . '".', 'tx_ter_api', -1);
            $result = [
                'resultCode' => TX_TER_RESULT_GENERAL_OK,
                'resultMessages' => []
            ];
        }

        return $result;
    }







    /*********************************************************
     *
     * uploadExtension helper functions
     *
     *********************************************************/

    /**
     * Creates a T3X file by using the extension info data and the files data and
     * writes the file to the repository's directory. By default this function creates
     * gzip compressed T3X files.
     *
     * After writing the extension, some files specific data (like the file size) is
     * added to $extensionInfoData for later informational use.
     *
     * This function additionally extracts the preview images and the extension icon by calling
     * saveImages().
     *
     * @param object $extensionInfoData : The general extension information as received by the SOAP server
     * @param object $filesData : The array of file data objects as received by the SOAP server
     *
     * @return void
     * @throws tx_ter_exception_internalServerError
     * @throws tx_ter_exception_notFound
     * @access protected
     */
    public function uploadExtension_writeExtensionAndIconFile(&$extensionInfoData, $filesData)
    {
        if (!@is_dir($this->parentObj->repositoryDir)) {
            throw new tx_ter_exception_internalServerError(
                'Extension repository directory does not exist.', TX_TER_ERROR_GENERAL_EXTREPDIRDOESNTEXIST
            );
        }
        if (!is_array($filesData->fileData)) {
            throw new tx_ter_exception_notFound('Extension contains no files.', TX_TER_ERROR_GENERAL_EXTENSIONCONTAINSNOFILES);
        }

        // Prepare Files Data Array:
        $preparedFilesDataArr = [];
        foreach ($filesData->fileData as $fileData) {

            $decodedContent = base64_decode($fileData->content);
            if ($fileData->contentMD5 != md5($decodedContent)) {
                throw new tx_ter_exception_notFound(
                    'MD5 does not match for file ' . (string)$fileData->name, TX_TER_ERROR_UPLOADEXTENSION_FILEMD5DOESNOTMATCH
                );
            }

            $preparedFilesDataArr[$fileData->name] = [
                'name' => $fileData->name,
                'size' => $fileData->size,
                'mtime' => $fileData->modificationTime,
                'is_executable' => $fileData->isExecutable,
                'content' => $decodedContent,
                'content_md5' => md5($decodedContent)
            ];
        }

        $extensionKey = strtolower($extensionInfoData->extensionKey);
        $constraints = [];

        if (is_array($extensionInfoData->technicalData->dependencies)) {
            foreach ($extensionInfoData->technicalData->dependencies as $dependency) {
                $dependency = json_decode(json_encode($dependency), true);
                if (!empty($dependency['kind']) && !empty($dependency['extensionKey']) && in_array(
                        $dependency['kind'], ['depends', 'conflicts', 'suggests'], true
                    )
                ) {
                    $constraints[$dependency['kind']][$dependency['extensionKey']] = (string)$dependency['versionRange'];
                }
            }
        }

        // Prepare EM_CONF Array:
        $preparedEMConfArr = [
            'title' => $extensionInfoData->metaData->title,
            'description' => $extensionInfoData->metaData->description,
            'category' => $extensionInfoData->metaData->category,
            'shy' => in_array(strtolower((string)$extensionInfoData->technicalData->shy), ['1', 'false'], true),
            'version' => $extensionInfoData->version,
            'priority' => $extensionInfoData->technicalData->priority,
            'loadOrder' => $extensionInfoData->technicalData->loadOrder,
            'module' => $extensionInfoData->technicalData->modules,
            'state' => $extensionInfoData->metaData->state,
            'uploadfolder' => in_array(strtolower((string)$extensionInfoData->technicalData->uploadFolder), ['1', 'false'], true),
            'createDirs' => $extensionInfoData->technicalData->createDirs,
            'modify_tables' => $extensionInfoData->technicalData->modifyTables,
            'clearcacheonload' => in_array(
                strtolower((string)$extensionInfoData->technicalData->clearCacheOnLoad), ['1', 'false'], true
            ),
            'lockType' => $extensionInfoData->technicalData->lockType,
            'author' => $extensionInfoData->metaData->authorName,
            'author_email' => $extensionInfoData->metaData->authorEmail,
            'author_company' => $extensionInfoData->metaData->authorCompany,
            'CGLcompliance' => $extensionInfoData->infoData->codingGuidelineCompliance,
            'CGLcompliance_note' => $extensionInfoData->infoData->codeingGuidelineComplianceNote,
            'constraints' => $constraints
        ];

        // Compile T3X Data Array:
        $dataArr = [
            'extKey' => $extensionKey,
            'EM_CONF' => $preparedEMConfArr,
            'misc' => [],
            'techInfo' => [],
            'FILES' => $preparedFilesDataArr
        ];

        $t3xFileUncompressedData = serialize($dataArr);
        $t3xFileData = md5($t3xFileUncompressedData) . ':gzcompress:' . gzcompress($t3xFileUncompressedData);

        // Check if size of t3x file is too big:
        if (strlen($t3xFileData) > $this->extensionMaxUploadSize) {
            throw new tx_ter_exception_notFound(
                'The extension size exceeded ' . $this->extensionMaxUploadSize . ' bytes which is the maximum for extension uploads.',
                TX_TER_ERROR_UPLOADEXTENSION_EXTENSIONTOOBIG
            );
        }

        // Create directories and build filenames:
        $firstLetter = strtolower(substr($extensionInfoData->extensionKey, 0, 1));
        $secondLetter = strtolower(substr($extensionInfoData->extensionKey, 1, 1));
        $fullPath = $this->parentObj->repositoryDir . $firstLetter . '/' . $secondLetter . '/';

        if (@!is_dir($this->parentObj->repositoryDir . $firstLetter)) {
            mkdir($this->parentObj->repositoryDir . $firstLetter);
        }
        if (@!is_dir($this->parentObj->repositoryDir . $firstLetter . '/' . $secondLetter)) {
            mkdir($this->parentObj->repositoryDir . $firstLetter . '/' . $secondLetter);
        }

        list($majorVersion, $minorVersion, $devVersion) = GeneralUtility::intExplode(
            '.', $extensionInfoData->version
        );
        $t3xFileName = $extensionKey . '_' . $majorVersion . '.' . $minorVersion . '.' . $devVersion . '.t3x';

        // Write the files
        $fh = @fopen($fullPath . $t3xFileName, 'wb');
        if (!$fh) {
            throw new tx_ter_exception_internalServerError(
                'Write error while writing .t3x file: ' . $fullPath . $t3xFileName,
                TX_TER_ERROR_UPLOADEXTENSION_WRITEERRORWHILEWRITINGFILES
            );
        }
        fwrite($fh, $t3xFileData);
        fclose($fh);

        $imageBaseName = $extensionKey . '_' . $majorVersion . '.' . $minorVersion . '.' . $devVersion;
        $this->saveImages($preparedFilesDataArr, $imageBaseName, $fullPath);

        // Write some data back to $extensionInfoData:
        $extensionInfoData->t3xFileMD5 = md5($t3xFileData);
        $extensionInfoData->infoData->dataSize = strlen($t3xFileUncompressedData);
        $extensionInfoData->infoData->dataSizeCompressed = strlen($t3xFileData);
    }

    /**
     * Extracts information from the extension information and stores it as a record in the database
     * tables. These tables are used for quickly getting information about extensions for display
     * in the TER frontend plugin.
     *
     * Note: All data written to the database (like everywhere else in the TER handling) is assumed to be
     * utf-8 encoded!
     *
     * @param    object $accountData : Username and passwords
     * @param    object $extensionInfoData : The general extension information as received by the SOAP server
     * @param    array $filesData : The array of file data objects as received by the SOAP server
     *
     * @return    void
     * @access    public
     */
    public function uploadExtension_writeExtensionInfoToDB($accountData, $extensionInfoData, $filesData)
    {
        // Prepare information about files
        $extensionInfoData->technicalData->isManualIncluded = 0;
        $composerInfo = [];
        foreach ($filesData->fileData as $fileData) {
            $extensionInfoData->infoData->files[$fileData->name] = [
                'filename' => $fileData->name,
                'size' => $fileData->size,
                'mtime' => $fileData->modificationTime,
                'is_executable' => $fileData->isExecutable,
            ];

            switch (trim($fileData->name, '/\\')) {
                case 'doc/manual.sxw':
                    $extensionInfoData->technicalData->isManualIncluded = 1;
                    break;
                case 'ext_emconf.php':
                    $autoload = [];
                    if (is_callable('Tx_TerFe2_Utility_Archive::extractEmConf')) {
                        $emConfData = Tx_TerFe2_Utility_Archive::extractEmConf(base64_decode($fileData->content));
                        if (!empty($emConfData['autoload'])) {
                            $autoload = $emConfData['autoload'];
                        }
                    }
                    break;
                case 'composer.json':
                    $composerJsonData = json_decode(base64_decode($fileData->content), true);
                    if (!empty($composerJsonData['autoload'])) {
                        $composerInfo['autoload'] = $composerJsonData['autoload'];
                    }
                    $composerInfo['name'] = $composerJsonData['name'];
                    break;
                default:
                    // Nothing to do here
            }
        }
        if (empty($composerInfo) && !empty($autoload)) {
            $composerInfo = ['autoload' => $autoload];
        }
        $extensionInfoData->technicalData->composerInfo = $composerInfo;
        $extensionKey = strtolower($extensionInfoData->extensionKey);

        // Prepare the new records
        $extensionRow = [
            'tstamp' => $GLOBALS['SIM_EXEC_TIME'],
            'crdate' => $GLOBALS['SIM_EXEC_TIME'],
            'pid' => (int)$this->parentObj->extensionsPID,
            'extensionkey' => $extensionKey,
            'version' => $extensionInfoData->version,
            'title' => $extensionInfoData->metaData->title,
            'description' => $extensionInfoData->metaData->description,
            'state' => $extensionInfoData->metaData->state,
            'category' => $extensionInfoData->metaData->category,
            'ismanualincluded' => $extensionInfoData->technicalData->isManualIncluded,
            't3xfilemd5' => $extensionInfoData->t3xFileMD5,
            'reviewstate' => 0,
        ];

        // Update an existing or insert a new extension record
        $table = 'tx_ter_extensions';
        $where = 'extensionkey = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($extensionKey, $table) . '
				  AND version  = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($extensionInfoData->version, $table);
        $extensionUid = $this->updateOrInsertRecord($table, $extensionRow, $where);

        // Get dependencies
        $dependenciesArr = [];
        if (is_array($extensionInfoData->technicalData->dependencies)) {
            foreach ($extensionInfoData->technicalData->dependencies as $dependency) {
                $dependencyAsArray = (array)$dependency;
                if ($dependencyAsArray['extensionKey']) {
                    $dependenciesArr[] = [
                        'kind' => $dependencyAsArray['kind'],
                        'extensionKey' => $dependencyAsArray['extensionKey'],
                        'versionRange' => $dependencyAsArray['versionRange']
                    ];
                }
            }
        }

        // Cleanup some attributes
        $attributes = ['shy', 'uploadFolder', 'clearCacheOnLoad'];
        foreach ($attributes as $attribute) {
            if (empty($extensionInfoData->technicalData->$attribute) || $extensionInfoData->technicalData->$attribute === 'false') {
                $extensionInfoData->technicalData->$attribute = false;
            } else {
                $extensionInfoData->technicalData->$attribute = true;
            }
        }

        // Prepare details row
        $extensionDetailsRow = [
            'pid' => (int)$this->parentObj->extensionsPID,
            'extensionuid' => (int)$extensionUid,
            'uploadcomment' => $extensionInfoData->infoData->uploadComment,
            'lastuploadbyusername' => $accountData->username,
            'lastuploaddate' => $GLOBALS['SIM_EXEC_TIME'],
            'datasize' => $extensionInfoData->infoData->dataSize,
            'datasizecompressed' => $extensionInfoData->infoData->dataSizeCompressed,
            'files' => serialize($extensionInfoData->infoData->files),
            'codelines' => $extensionInfoData->infoData->codeLines,
            'codebytes' => $extensionInfoData->infoData->codeBytes,
            'techinfo' => serialize($extensionInfoData->infoData->techInfo),
            'composerinfo' => json_encode($extensionInfoData->technicalData->composerInfo),
            'shy' => (int)$extensionInfoData->technicalData->shy,
            'dependencies' => serialize($dependenciesArr),
            'createdirs' => $extensionInfoData->technicalData->createDirs,
            'priority' => $extensionInfoData->technicalData->priority,
            'modules' => $extensionInfoData->technicalData->modules,
            'uploadfolder' => (int)$extensionInfoData->technicalData->uploadFolder,
            'modifytables' => $extensionInfoData->technicalData->modifyTables,
            'clearcacheonload' => (int)$extensionInfoData->technicalData->clearCacheOnLoad,
            'locktype' => $extensionInfoData->technicalData->lockType,
            'authorname' => $extensionInfoData->metaData->authorName,