Skip to content

Commit e397103

Browse files
author
epriestley
committed
Extend all "ManagementWorkflow" classes from a base class
Summary: Ref T2015. Not directly related to Drydock, but I've wanted to do this for a bit. Introduce a common base class for all the workflows in the scripts in `bin/*`. This slightly reduces code duplication by moving `isExecutable()` to the base, but also provides `getViewer()`. This is a little nicer than `PhabricatorUser::getOmnipotentUser()` and gives us a layer of indirection if we ever want to introduce more general viewer mechanisms in scripts. Test Plan: Lint; ran some of the scripts. Reviewers: btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T2015 Differential Revision: https://secure.phabricator.com/D7838
1 parent 1ba52fa commit e397103

File tree

40 files changed

+77
-138
lines changed

40 files changed

+77
-138
lines changed

‎src/__phutil_library_map__.php‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1560,6 +1560,7 @@
15601560
'PhabricatorMainMenuIconView' => 'view/page/menu/PhabricatorMainMenuIconView.php',
15611561
'PhabricatorMainMenuSearchView' => 'view/page/menu/PhabricatorMainMenuSearchView.php',
15621562
'PhabricatorMainMenuView' => 'view/page/menu/PhabricatorMainMenuView.php',
1563+
'PhabricatorManagementWorkflow' => 'infrastructure/management/PhabricatorManagementWorkflow.php',
15631564
'PhabricatorManiphestConfigOptions' => 'applications/maniphest/config/PhabricatorManiphestConfigOptions.php',
15641565
'PhabricatorManiphestTaskTestDataGenerator' => 'applications/maniphest/lipsum/PhabricatorManiphestTaskTestDataGenerator.php',
15651566
'PhabricatorMarkupCache' => 'applications/cache/storage/PhabricatorMarkupCache.php',
@@ -3020,7 +3021,7 @@
30203021
'DivinerReturnTableView' => 'AphrontTagView',
30213022
'DivinerSectionView' => 'AphrontTagView',
30223023
'DivinerStaticPublisher' => 'DivinerPublisher',
3023-
'DivinerWorkflow' => 'PhutilArgumentWorkflow',
3024+
'DivinerWorkflow' => 'PhabricatorManagementWorkflow',
30243025
'DoorkeeperBridge' => 'Phobject',
30253026
'DoorkeeperBridgeAsana' => 'DoorkeeperBridge',
30263027
'DoorkeeperBridgeJIRA' => 'DoorkeeperBridge',
@@ -3099,7 +3100,7 @@
30993100
'DrydockManagementCreateResourceWorkflow' => 'DrydockManagementWorkflow',
31003101
'DrydockManagementLeaseWorkflow' => 'DrydockManagementWorkflow',
31013102
'DrydockManagementReleaseWorkflow' => 'DrydockManagementWorkflow',
3102-
'DrydockManagementWorkflow' => 'PhutilArgumentWorkflow',
3103+
'DrydockManagementWorkflow' => 'PhabricatorManagementWorkflow',
31033104
'DrydockPHIDTypeBlueprint' => 'PhabricatorPHIDType',
31043105
'DrydockPHIDTypeLease' => 'PhabricatorPHIDType',
31053106
'DrydockPHIDTypeResource' => 'PhabricatorPHIDType',
@@ -3197,7 +3198,7 @@
31973198
'HarbormasterDAO' => 'PhabricatorLiskDAO',
31983199
'HarbormasterHTTPRequestBuildStepImplementation' => 'VariableBuildStepImplementation',
31993200
'HarbormasterManagementBuildWorkflow' => 'HarbormasterManagementWorkflow',
3200-
'HarbormasterManagementWorkflow' => 'PhutilArgumentWorkflow',
3201+
'HarbormasterManagementWorkflow' => 'PhabricatorManagementWorkflow',
32013202
'HarbormasterObject' => 'HarbormasterDAO',
32023203
'HarbormasterPHIDTypeBuild' => 'PhabricatorPHIDType',
32033204
'HarbormasterPHIDTypeBuildItem' => 'PhabricatorPHIDType',
@@ -3672,7 +3673,7 @@
36723673
'PhabricatorAuditListView' => 'AphrontView',
36733674
'PhabricatorAuditMailReceiver' => 'PhabricatorObjectMailReceiver',
36743675
'PhabricatorAuditManagementDeleteWorkflow' => 'PhabricatorAuditManagementWorkflow',
3675-
'PhabricatorAuditManagementWorkflow' => 'PhutilArgumentWorkflow',
3676+
'PhabricatorAuditManagementWorkflow' => 'PhabricatorManagementWorkflow',
36763677
'PhabricatorAuditPreviewController' => 'PhabricatorAuditController',
36773678
'PhabricatorAuditReplyHandler' => 'PhabricatorMailReplyHandler',
36783679
'PhabricatorAuthAccountView' => 'AphrontView',
@@ -3687,7 +3688,7 @@
36873688
'PhabricatorAuthManagementLDAPWorkflow' => 'PhabricatorAuthManagementWorkflow',
36883689
'PhabricatorAuthManagementRecoverWorkflow' => 'PhabricatorAuthManagementWorkflow',
36893690
'PhabricatorAuthManagementRefreshWorkflow' => 'PhabricatorAuthManagementWorkflow',
3690-
'PhabricatorAuthManagementWorkflow' => 'PhutilArgumentWorkflow',
3691+
'PhabricatorAuthManagementWorkflow' => 'PhabricatorManagementWorkflow',
36913692
'PhabricatorAuthNeedsApprovalController' => 'PhabricatorAuthController',
36923693
'PhabricatorAuthNewController' => 'PhabricatorAuthProviderConfigController',
36933694
'PhabricatorAuthOldOAuthRedirectController' => 'PhabricatorAuthController',
@@ -3740,7 +3741,7 @@
37403741
'PhabricatorBusyExample' => 'PhabricatorUIExample',
37413742
'PhabricatorCacheDAO' => 'PhabricatorLiskDAO',
37423743
'PhabricatorCacheManagementPurgeWorkflow' => 'PhabricatorSearchManagementWorkflow',
3743-
'PhabricatorCacheManagementWorkflow' => 'PhutilArgumentWorkflow',
3744+
'PhabricatorCacheManagementWorkflow' => 'PhabricatorManagementWorkflow',
37443745
'PhabricatorCalendarBrowseController' => 'PhabricatorCalendarController',
37453746
'PhabricatorCalendarController' => 'PhabricatorController',
37463747
'PhabricatorCalendarDAO' => 'PhabricatorLiskDAO',
@@ -3815,7 +3816,7 @@
38153816
'PhabricatorConfigManagementGetWorkflow' => 'PhabricatorConfigManagementWorkflow',
38163817
'PhabricatorConfigManagementListWorkflow' => 'PhabricatorConfigManagementWorkflow',
38173818
'PhabricatorConfigManagementSetWorkflow' => 'PhabricatorConfigManagementWorkflow',
3818-
'PhabricatorConfigManagementWorkflow' => 'PhutilArgumentWorkflow',
3819+
'PhabricatorConfigManagementWorkflow' => 'PhabricatorManagementWorkflow',
38193820
'PhabricatorConfigOption' =>
38203821
array(
38213822
0 => 'Phobject',
@@ -3892,7 +3893,7 @@
38923893
'PhabricatorDaemonManagementStartWorkflow' => 'PhabricatorDaemonManagementWorkflow',
38933894
'PhabricatorDaemonManagementStatusWorkflow' => 'PhabricatorDaemonManagementWorkflow',
38943895
'PhabricatorDaemonManagementStopWorkflow' => 'PhabricatorDaemonManagementWorkflow',
3895-
'PhabricatorDaemonManagementWorkflow' => 'PhutilArgumentWorkflow',
3896+
'PhabricatorDaemonManagementWorkflow' => 'PhabricatorManagementWorkflow',
38963897
'PhabricatorDataNotAttachedException' => 'Exception',
38973898
'PhabricatorDebugController' => 'PhabricatorController',
38983899
'PhabricatorDefaultFileStorageEngineSelector' => 'PhabricatorFileStorageEngineSelector',
@@ -3946,7 +3947,7 @@
39463947
'PhabricatorFactManagementDestroyWorkflow' => 'PhabricatorFactManagementWorkflow',
39473948
'PhabricatorFactManagementListWorkflow' => 'PhabricatorFactManagementWorkflow',
39483949
'PhabricatorFactManagementStatusWorkflow' => 'PhabricatorFactManagementWorkflow',
3949-
'PhabricatorFactManagementWorkflow' => 'PhutilArgumentWorkflow',
3950+
'PhabricatorFactManagementWorkflow' => 'PhabricatorManagementWorkflow',
39503951
'PhabricatorFactRaw' => 'PhabricatorFactDAO',
39513952
'PhabricatorFactSimpleSpec' => 'PhabricatorFactSpec',
39523953
'PhabricatorFactUpdateIterator' => 'PhutilBufferedIterator',
@@ -3960,7 +3961,7 @@
39603961
1 => 'PhabricatorApplicationSearchResultsControllerInterface',
39613962
),
39623963
'PhabricatorFeedManagementRepublishWorkflow' => 'PhabricatorFeedManagementWorkflow',
3963-
'PhabricatorFeedManagementWorkflow' => 'PhutilArgumentWorkflow',
3964+
'PhabricatorFeedManagementWorkflow' => 'PhabricatorManagementWorkflow',
39643965
'PhabricatorFeedPublicStreamController' => 'PhabricatorFeedController',
39653966
'PhabricatorFeedQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
39663967
'PhabricatorFeedSearchEngine' => 'PhabricatorApplicationSearchEngine',
@@ -4029,7 +4030,7 @@
40294030
'PhabricatorFilesManagementMigrateWorkflow' => 'PhabricatorFilesManagementWorkflow',
40304031
'PhabricatorFilesManagementPurgeWorkflow' => 'PhabricatorFilesManagementWorkflow',
40314032
'PhabricatorFilesManagementRebuildWorkflow' => 'PhabricatorFilesManagementWorkflow',
4032-
'PhabricatorFilesManagementWorkflow' => 'PhutilArgumentWorkflow',
4033+
'PhabricatorFilesManagementWorkflow' => 'PhabricatorManagementWorkflow',
40334034
'PhabricatorFlag' =>
40344035
array(
40354036
0 => 'PhabricatorFlagDAO',
@@ -4077,7 +4078,7 @@
40774078
'PhabricatorLegalpadPHIDTypeDocument' => 'PhabricatorPHIDType',
40784079
'PhabricatorLintEngine' => 'PhutilLintEngine',
40794080
'PhabricatorLipsumGenerateWorkflow' => 'PhabricatorLipsumManagementWorkflow',
4080-
'PhabricatorLipsumManagementWorkflow' => 'PhutilArgumentWorkflow',
4081+
'PhabricatorLipsumManagementWorkflow' => 'PhabricatorManagementWorkflow',
40814082
'PhabricatorLipsumMondrianArtist' => 'PhabricatorLipsumArtist',
40824083
'PhabricatorLiskDAO' => 'LiskDAO',
40834084
'PhabricatorLocalDiskFileStorageEngine' => 'PhabricatorFileStorageEngine',
@@ -4119,7 +4120,7 @@
41194120
'PhabricatorMailManagementSendTestWorkflow' => 'PhabricatorSearchManagementWorkflow',
41204121
'PhabricatorMailManagementShowInboundWorkflow' => 'PhabricatorSearchManagementWorkflow',
41214122
'PhabricatorMailManagementShowOutboundWorkflow' => 'PhabricatorSearchManagementWorkflow',
4122-
'PhabricatorMailManagementWorkflow' => 'PhutilArgumentWorkflow',
4123+
'PhabricatorMailManagementWorkflow' => 'PhabricatorManagementWorkflow',
41234124
'PhabricatorMailReceiverTestCase' => 'PhabricatorTestCase',
41244125
'PhabricatorMailingListPHIDTypeList' => 'PhabricatorPHIDType',
41254126
'PhabricatorMailingListQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
@@ -4135,6 +4136,7 @@
41354136
'PhabricatorMainMenuIconView' => 'AphrontView',
41364137
'PhabricatorMainMenuSearchView' => 'AphrontView',
41374138
'PhabricatorMainMenuView' => 'AphrontView',
4139+
'PhabricatorManagementWorkflow' => 'PhutilArgumentWorkflow',
41384140
'PhabricatorManiphestConfigOptions' => 'PhabricatorApplicationConfigOptions',
41394141
'PhabricatorManiphestTaskTestDataGenerator' => 'PhabricatorTestDataGenerator',
41404142
'PhabricatorMarkupCache' => 'PhabricatorCacheDAO',
@@ -4305,7 +4307,7 @@
43054307
'PhabricatorPolicyInterface' => 'PhabricatorPHIDInterface',
43064308
'PhabricatorPolicyManagementShowWorkflow' => 'PhabricatorPolicyManagementWorkflow',
43074309
'PhabricatorPolicyManagementUnlockWorkflow' => 'PhabricatorPolicyManagementWorkflow',
4308-
'PhabricatorPolicyManagementWorkflow' => 'PhutilArgumentWorkflow',
4310+
'PhabricatorPolicyManagementWorkflow' => 'PhabricatorManagementWorkflow',
43094311
'PhabricatorPolicyPHIDTypePolicy' => 'PhabricatorPHIDType',
43104312
'PhabricatorPolicyQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
43114313
'PhabricatorPolicyRuleAdministrators' => 'PhabricatorPolicyRule',
@@ -4421,7 +4423,7 @@
44214423
'PhabricatorRepositoryManagementLookupUsersWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
44224424
'PhabricatorRepositoryManagementMarkImportedWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
44234425
'PhabricatorRepositoryManagementPullWorkflow' => 'PhabricatorRepositoryManagementWorkflow',
4424-
'PhabricatorRepositoryManagementWorkflow' => 'PhutilArgumentWorkflow',
4426+
'PhabricatorRepositoryManagementWorkflow' => 'PhabricatorManagementWorkflow',
44254427
'PhabricatorRepositoryMercurialCommitChangeParserWorker' => 'PhabricatorRepositoryCommitChangeParserWorker',
44264428
'PhabricatorRepositoryMercurialCommitMessageParserWorker' => 'PhabricatorRepositoryCommitMessageParserWorker',
44274429
'PhabricatorRepositoryMirror' =>
@@ -4459,7 +4461,7 @@
44594461
'PhabricatorS3FileStorageEngine' => 'PhabricatorFileStorageEngine',
44604462
'PhabricatorSSHLog' => 'Phobject',
44614463
'PhabricatorSSHPassthruCommand' => 'Phobject',
4462-
'PhabricatorSSHWorkflow' => 'PhutilArgumentWorkflow',
4464+
'PhabricatorSSHWorkflow' => 'PhabricatorManagementWorkflow',
44634465
'PhabricatorSavedQuery' =>
44644466
array(
44654467
0 => 'PhabricatorSearchDAO',
@@ -4480,7 +4482,7 @@
44804482
'PhabricatorSearchEngineMySQL' => 'PhabricatorSearchEngine',
44814483
'PhabricatorSearchHovercardController' => 'PhabricatorSearchBaseController',
44824484
'PhabricatorSearchManagementIndexWorkflow' => 'PhabricatorSearchManagementWorkflow',
4483-
'PhabricatorSearchManagementWorkflow' => 'PhutilArgumentWorkflow',
4485+
'PhabricatorSearchManagementWorkflow' => 'PhabricatorManagementWorkflow',
44844486
'PhabricatorSearchOrderController' => 'PhabricatorSearchBaseController',
44854487
'PhabricatorSearchQuery' => 'PhabricatorSearchDAO',
44864488
'PhabricatorSearchResultView' => 'AphrontView',
@@ -4574,7 +4576,7 @@
45744576
'PhabricatorStorageManagementProbeWorkflow' => 'PhabricatorStorageManagementWorkflow',
45754577
'PhabricatorStorageManagementStatusWorkflow' => 'PhabricatorStorageManagementWorkflow',
45764578
'PhabricatorStorageManagementUpgradeWorkflow' => 'PhabricatorStorageManagementWorkflow',
4577-
'PhabricatorStorageManagementWorkflow' => 'PhutilArgumentWorkflow',
4579+
'PhabricatorStorageManagementWorkflow' => 'PhabricatorManagementWorkflow',
45784580
'PhabricatorSubscribersQuery' => 'PhabricatorQuery',
45794581
'PhabricatorSubscriptionsEditController' => 'PhabricatorController',
45804582
'PhabricatorSubscriptionsEditor' => 'PhabricatorEditor',

‎src/applications/audit/management/PhabricatorAuditManagementDeleteWorkflow.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,10 +178,6 @@ public function execute(PhutilArgumentParser $args) {
178178
return 0;
179179
}
180180

181-
private function getViewer() {
182-
return PhabricatorUser::getOmnipotentUser();
183-
}
184-
185181
private function loadUsers($users) {
186182
$users = $this->parseList($users);
187183
if (!$users) {

‎src/applications/audit/management/PhabricatorAuditManagementWorkflow.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
<?php
22

33
abstract class PhabricatorAuditManagementWorkflow
4-
extends PhutilArgumentWorkflow {
5-
6-
public function isExecutable() {
7-
return true;
8-
}
4+
extends PhabricatorManagementWorkflow {
95

106
}

‎src/applications/auth/management/PhabricatorAuthManagementRecoverWorkflow.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ protected function didConstruct() {
2222
public function execute(PhutilArgumentParser $args) {
2323

2424
$can_recover = id(new PhabricatorPeopleQuery())
25-
->setViewer(PhabricatorUser::getOmnipotentUser())
25+
->setViewer($this->getViewer())
2626
->withIsAdmin(true)
2727
->execute();
2828
if (!$can_recover) {
@@ -48,7 +48,7 @@ public function execute(PhutilArgumentParser $args) {
4848
$username = head($usernames);
4949

5050
$user = id(new PhabricatorPeopleQuery())
51-
->setViewer(PhabricatorUser::getOmnipotentUser())
51+
->setViewer($this->getViewer())
5252
->withUsernames(array($username))
5353
->executeOne();
5454

‎src/applications/auth/management/PhabricatorAuthManagementRefreshWorkflow.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ protected function didConstruct() {
3333

3434
public function execute(PhutilArgumentParser $args) {
3535
$console = PhutilConsole::getConsole();
36-
$viewer = PhabricatorUser::getOmnipotentUser();
36+
$viewer = $this->getViewer();
3737

3838
$query = id(new PhabricatorExternalAccountQuery())
3939
->setViewer($viewer);

‎src/applications/auth/management/PhabricatorAuthManagementWorkflow.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
<?php
22

33
abstract class PhabricatorAuthManagementWorkflow
4-
extends PhutilArgumentWorkflow {
5-
6-
final public function isExecutable() {
7-
return true;
8-
}
4+
extends PhabricatorManagementWorkflow {
95

106
}

‎src/applications/cache/management/PhabricatorCacheManagementWorkflow.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
<?php
22

33
abstract class PhabricatorCacheManagementWorkflow
4-
extends PhutilArgumentWorkflow {
5-
6-
final public function isExecutable() {
7-
return true;
8-
}
4+
extends PhabricatorManagementWorkflow {
95

106
}

‎src/applications/config/management/PhabricatorConfigManagementWorkflow.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
<?php
22

33
abstract class PhabricatorConfigManagementWorkflow
4-
extends PhutilArgumentWorkflow {
5-
6-
final public function isExecutable() {
7-
return true;
8-
}
4+
extends PhabricatorManagementWorkflow {
95

106
}

‎src/applications/daemon/management/PhabricatorDaemonManagementLogWorkflow.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function execute(PhutilArgumentParser $args) {
3232
$id = head($id);
3333

3434
$daemon = id(new PhabricatorDaemonLogQuery())
35-
->setViewer(PhabricatorUser::getOmnipotentUser())
35+
->setViewer($this->getViewer())
3636
->withIDs(array($id))
3737
->executeOne();
3838

‎src/applications/daemon/management/PhabricatorDaemonManagementWorkflow.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
<?php
22

33
abstract class PhabricatorDaemonManagementWorkflow
4-
extends PhutilArgumentWorkflow {
5-
6-
public function isExecutable() {
7-
return true;
8-
}
4+
extends PhabricatorManagementWorkflow {
95

106
protected function loadAvailableDaemonClasses() {
117
$loader = new PhutilSymbolLoader();

0 commit comments

Comments
 (0)