src/applications/releeph/controller/product/ReleephProductEditController.php

   1 <?php
   2
   3 final class ReleephProductEditController extends ReleephProductController {
   4
   5   public function handleRequest(AphrontRequest $request) {
   6     $viewer = $request->getViewer();
   7     $id = $request->getURIData('projectID');
   8
   9     $product = id(new ReleephProductQuery())
  10       ->setViewer($viewer)
  11       ->withIDs(array($id))
  12       ->requireCapabilities(
  13         array(
  14           PhabricatorPolicyCapability::CAN_VIEW,
  15           PhabricatorPolicyCapability::CAN_EDIT,
  16         ))
  17       ->executeOne();
  18     if (!$product) {
  19       return new Aphront404Response();
  20     }
  21     $this->setProduct($product);
  22
  23     $e_name = true;
  24     $e_trunk_branch = true;
  25     $e_branch_template = false;
  26     $errors = array();
  27
  28     $product_name = $request->getStr('name', $product->getName());
  29
  30     $trunk_branch = $request->getStr('trunkBranch', $product->getTrunkBranch());
  31     $branch_template = $request->getStr('branchTemplate');
  32     if ($branch_template === null) {
  33       $branch_template = $product->getDetail('branchTemplate');
  34     }
  35     $pick_failure_instructions = $request->getStr('pickFailureInstructions',
  36       $product->getDetail('pick_failure_instructions'));
  37     $test_paths = $request->getStr('testPaths');
  38     if ($test_paths !== null) {
  39       $test_paths = array_filter(explode("\n", $test_paths));
  40     } else {
  41       $test_paths = $product->getDetail('testPaths', array());
  42     }
  43
  44     $repository_phid = $product->getRepositoryPHID();
  45
  46     if ($request->isFormPost()) {
  47       $pusher_phids = $request->getArr('pushers');
  48
  49       if (!$product_name) {
  50         $e_name = pht('Required');
  51         $errors[] =
  52           pht('Your Releeph product should have a simple descriptive name.');
  53       }
  54
  55       if (!$trunk_branch) {
  56         $e_trunk_branch = pht('Required');
  57         $errors[] =
  58           pht('You must specify which branch you will be picking from.');
  59       }
  60
  61       $other_releeph_products = id(new ReleephProject())
  62         ->loadAllWhere('id != %d', $product->getID());
  63       $other_releeph_product_names = mpull($other_releeph_products,
  64         'getName', 'getID');
  65
  66       if (in_array($product_name, $other_releeph_product_names)) {
  67         $errors[] = pht('Releeph product name %s is already taken',
  68           $product_name);
  69       }
  70
  71       foreach ($test_paths as $test_path) {
  72         $result = @preg_match($test_path, '');
  73         $is_a_valid_regexp = $result !== false;
  74         if (!$is_a_valid_regexp) {
  75           $errors[] = pht('Please provide a valid regular expression: '.
  76             '%s is not valid', $test_path);
  77         }
  78       }
  79
  80       $product
  81         ->setName($product_name)
  82         ->setTrunkBranch($trunk_branch)
  83         ->setDetail('pushers', $pusher_phids)
  84         ->setDetail('pick_failure_instructions', $pick_failure_instructions)
  85         ->setDetail('branchTemplate', $branch_template)
  86         ->setDetail('testPaths', $test_paths);
  87
  88       $fake_commit_handle = ReleephBranchTemplate::getFakeCommitHandleFor(
  89         $repository_phid,
  90         $viewer);
  91
  92       if ($branch_template) {
  93         list($branch_name, $template_errors) = id(new ReleephBranchTemplate())
  94           ->setCommitHandle($fake_commit_handle)
  95           ->setReleephProjectName($product_name)
  96           ->interpolate($branch_template);
  97
  98         if ($template_errors) {
  99           $e_branch_template = pht('Whoopsies!');
 100           foreach ($template_errors as $template_error) {
 101             $errors[] = pht('Template error: %s', $template_error);
 102           }
 103         }
 104       }
 105
 106       if (!$errors) {
 107         $product->save();
 108
 109         return id(new AphrontRedirectResponse())->setURI($product->getURI());
 110       }
 111     }
 112
 113     $pusher_phids = $request->getArr(
 114       'pushers',
 115       $product->getDetail('pushers', array()));
 116
 117     $form = id(new AphrontFormView())
 118       ->setUser($request->getUser())
 119       ->appendChild(
 120         id(new AphrontFormTextControl())
 121           ->setLabel(pht('Name'))
 122           ->setName('name')
 123           ->setValue($product_name)
 124           ->setError($e_name)
 125           ->setCaption(pht('A name like "Thrift" but not "Thrift releases".')))
 126       ->appendChild(
 127         id(new AphrontFormStaticControl())
 128           ->setLabel(pht('Repository'))
 129           ->setValue(
 130             $product->getRepository()->getName()))
 131       ->appendChild(
 132         id(new AphrontFormStaticControl())
 133           ->setLabel(pht('Repository'))
 134           ->setValue(
 135             $product->getRepository()->getName()))
 136       ->appendChild(
 137         id(new AphrontFormStaticControl())
 138           ->setLabel(pht('Releeph Project PHID'))
 139           ->setValue(
 140             $product->getPHID()))
 141       ->appendChild(
 142         id(new AphrontFormTextControl())
 143           ->setLabel(pht('Trunk'))
 144           ->setValue($trunk_branch)
 145           ->setName('trunkBranch')
 146           ->setError($e_trunk_branch))
 147       ->appendChild(
 148         id(new AphrontFormTextAreaControl())
 149           ->setLabel(pht('Pick Instructions'))
 150           ->setValue($pick_failure_instructions)
 151           ->setName('pickFailureInstructions')
 152           ->setCaption(
 153             pht('Instructions for pick failures, which will be used '.
 154             'in emails generated by failed picks')))
 155       ->appendChild(
 156         id(new AphrontFormTextAreaControl())
 157           ->setLabel(pht('Tests paths'))
 158           ->setValue(implode("\n", $test_paths))
 159           ->setName('testPaths')
 160           ->setCaption(
 161             pht('List of strings that all test files contain in their path '.
 162             'in this project. One string per line. '.
 163             'Examples: \'__tests__\', \'/javatests/\'...')));
 164
 165     $branch_template_input = id(new AphrontFormTextControl())
 166       ->setName('branchTemplate')
 167       ->setValue($branch_template)
 168       ->setLabel(pht('Branch Template'))
 169       ->setError($e_branch_template)
 170       ->setCaption(
 171         pht("Leave this blank to use your installation's default."));
 172
 173     $branch_template_preview = id(new ReleephBranchPreviewView())
 174       ->setLabel(pht('Preview'))
 175       ->addControl('template', $branch_template_input)
 176       ->addStatic('repositoryPHID', $repository_phid)
 177       ->addStatic('isSymbolic', false)
 178       ->addStatic('projectName', $product->getName());
 179
 180     $form
 181       ->appendControl(
 182         id(new AphrontFormTokenizerControl())
 183           ->setLabel(pht('Pushers'))
 184           ->setName('pushers')
 185           ->setDatasource(new PhabricatorPeopleDatasource())
 186           ->setValue($pusher_phids))
 187       ->appendChild($branch_template_input)
 188       ->appendChild($branch_template_preview)
 189       ->appendRemarkupInstructions($this->getBranchHelpText());
 190
 191     $form
 192       ->appendChild(
 193         id(new AphrontFormSubmitControl())
 194           ->addCancelButton('/releeph/product/')
 195           ->setValue(pht('Save')));
 196
 197     $box = id(new PHUIObjectBoxView())
 198       ->setHeaderText(pht('Product'))
 199       ->setFormErrors($errors)
 200       ->setBackground(PHUIObjectBoxView::BLUE_PROPERTY)
 201       ->appendChild($form);
 202
 203     $title = pht('Edit Product');
 204
 205     $crumbs = $this->buildApplicationCrumbs();
 206     $crumbs->addTextCrumb(pht('Edit Product'));
 207     $crumbs->setBorder(true);
 208
 209     $header = id(new PHUIHeaderView())
 210       ->setHeader($title)
 211       ->setHeaderIcon('fa-pencil');
 212
 213     $view = id(new PHUITwoColumnView())
 214       ->setHeader($header)
 215       ->setFooter($box);
 216
 217     return $this->newPage()
 218       ->setTitle($title)
 219       ->setCrumbs($crumbs)
 220       ->appendChild($view);
 221
 222   }
 223
 224   private function getBranchHelpText() {
 225     return <<<EOTEXT
 226
 227 ==== Interpolations ====
 228
 229 | Code  | Meaning
 230 | ----- | -------
 231 | `%P`  | The name of your product, with spaces changed to "-".
 232 | `%p`  | Like %P, but all lowercase.
 233 | `%Y`  | The four digit year associated with the branch date.
 234 | `%m`  | The two digit month.
 235 | `%d`  | The two digit day.
 236 | `%v`  | The handle of the commit where the branch was cut ("rXYZa4b3c2d1").
 237 | `%V`  | The abbreviated commit id where the branch was cut ("a4b3c2d1").
 238 | `%..` | Any other sequence interpreted by `strftime()`.
 239 | `%%`  | A literal percent sign.
 240
 241
 242 ==== Tips for Branch Templates ====
 243
 244 Use a directory to separate your release branches from other branches:
 245
 246   lang=none
 247   releases/%Y-%M-%d-%v
 248   => releases/2012-30-16-rHERGE32cd512a52b7
 249
 250 Include a second hierarchy if you share your repository with other products:
 251
 252   lang=none
 253   releases/%P/%p-release-%Y%m%d-%V
 254   => releases/Tintin/tintin-release-20121116-32cd512a52b7
 255
 256 Keep your branch names simple, avoiding strange punctuation, most of which is
 257 forbidden or escaped anyway:
 258
 259   lang=none, counterexample
 260   releases//..clown-releases..//`date --iso=seconds`-$(sudo halt)
 261
 262 Include the date early in your template, in an order which sorts properly:
 263
 264   lang=none
 265   releases/%Y%m%d-%v
 266   => releases/20121116-rHERGE32cd512a52b7 (good!)
 267
 268   releases/%V-%m.%d.%Y
 269   => releases/32cd512a52b7-11.16.2012 (awful!)
 270
 271
 272 EOTEXT;
 273   }
 274
 275 }