@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Validate menu item fields (links, projects, dashboards, applications, forms, etc)
Summary:
Ref T12128. This adds validation to menu items.
This feels a touch flimsy-ish (kind of copy/paste heavy?) but maybe it can be cleaned up a bit once some similar lightweight modular item types (build steps in Harbormaster, blueprints in Drydock) convert.
Test Plan:
- Tried to create each item with errors (no dashboard, no project, etc). Got appropriate form errors.
- Created valid items of each type.
Reviewers: chad
Reviewed By: chad
Maniphest Tasks: T12128
Differential Revision: https://secure.phabricator.com/D17235
+396
-7
+43
src/applications/search/editor/PhabricatorProfileMenuEditEngine.php
+43
src/applications/search/editor/PhabricatorProfileMenuEditEngine.php
···
149
149
return $fields;
150
150
}
151
151
152
+
protected function getValidationExceptionShortMessage(
153
+
PhabricatorApplicationTransactionValidationException $ex,
154
+
PhabricatorEditField $field) {
155
+
156
+
// Menu item properties all have the same transaction type, so we need
157
+
// to make sure errors about a specific property (like the URI for a
158
+
// link) are only applied to the field for that particular property. If
159
+
// we don't do this, the red error text like "Required" will display
160
+
// next to every field.
161
+
162
+
$property_type =
163
+
PhabricatorProfileMenuItemConfigurationTransaction::TYPE_PROPERTY;
164
+
165
+
$xaction_type = $field->getTransactionType();
166
+
if ($xaction_type == $property_type) {
167
+
$field_key = $field->getKey();
168
+
foreach ($ex->getErrors() as $error) {
169
+
if ($error->getType() !== $xaction_type) {
170
+
continue;
171
+
}
172
+
173
+
$xaction = $error->getTransaction();
174
+
if (!$xaction) {
175
+
continue;
176
+
}
177
+
178
+
$xaction_setting = $xaction->getMetadataValue('property.key');
179
+
if ($xaction_setting != $field_key) {
180
+
continue;
181
+
}
182
+
183
+
$short_message = $error->getShortMessage();
184
+
if ($short_message !== null) {
185
+
return $short_message;
186
+
}
187
+
}
188
+
189
+
return null;
190
+
}
191
+
192
+
return parent::getValidationExceptionShortMessage($ex, $field);
193
+
}
194
+
152
195
}
+35
src/applications/search/editor/PhabricatorProfileMenuEditor.php
+35
src/applications/search/editor/PhabricatorProfileMenuEditor.php
···
87
87
return parent::applyCustomExternalTransaction($object, $xaction);
88
88
}
89
89
90
+
protected function validateTransaction(
91
+
PhabricatorLiskDAO $object,
92
+
$type,
93
+
array $xactions) {
94
+
95
+
$errors = parent::validateTransaction($object, $type, $xactions);
96
+
97
+
$actor = $this->getActor();
98
+
$menu_item = $object->getMenuItem();
99
+
$menu_item->setViewer($actor);
100
+
101
+
switch ($type) {
102
+
case PhabricatorProfileMenuItemConfigurationTransaction::TYPE_PROPERTY:
103
+
$key_map = array();
104
+
foreach ($xactions as $xaction) {
105
+
$xaction_key = $xaction->getMetadataValue('property.key');
106
+
$old = $this->getCustomTransactionOldValue($object, $xaction);
107
+
$new = $xaction->getNewValue();
108
+
$key_map[$xaction_key][] = array(
109
+
'xaction' => $xaction,
110
+
'old' => $old,
111
+
'new' => $new,
112
+
);
113
+
}
114
+
115
+
foreach ($object->validateTransactions($key_map) as $error) {
116
+
$errors[] = $error;
117
+
}
118
+
break;
119
+
}
120
+
121
+
return $errors;
122
+
}
123
+
124
+
90
125
}
+24
src/applications/search/storage/PhabricatorProfileMenuItemConfiguration.php
+24
src/applications/search/storage/PhabricatorProfileMenuItemConfiguration.php
···
126
126
return $this->getMenuItem()->willBuildNavigationItems($items);
127
127
}
128
128
129
+
public function validateTransactions(array $map) {
130
+
$item = $this->getMenuItem();
131
+
132
+
$fields = $item->buildEditEngineFields($this);
133
+
$errors = array();
134
+
foreach ($fields as $field) {
135
+
$field_key = $field->getKey();
136
+
137
+
$xactions = idx($map, $field_key, array());
138
+
$value = $this->getMenuItemProperty($field_key);
139
+
140
+
$field_errors = $item->validateTransactions(
141
+
$this,
142
+
$field_key,
143
+
$value,
144
+
$xactions);
145
+
foreach ($field_errors as $error) {
146
+
$errors[] = $error;
147
+
}
148
+
}
149
+
150
+
return $errors;
151
+
}
152
+
129
153
public function getSortVector() {
130
154
// Sort custom items above global items.
131
155
if ($this->getCustomPHID()) {
+4
src/applications/transactions/editengine/PhabricatorEditEngine.php
+4
src/applications/transactions/editengine/PhabricatorEditEngine.php