001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.petstore.console.pages;
018
019import static org.apache.juneau.commons.utils.StringUtils.*;
020
021import java.util.*;
022
023import org.apache.juneau.commons.beanquery.*;
024import org.apache.juneau.petstore.dto.*;
025import org.apache.juneau.console.freemarker.*;
026import org.apache.juneau.console.views.*;
027import org.apache.juneau.console.views.RowAction.*;
028import org.apache.juneau.console.views.TableSpec.*;
029import org.apache.juneau.console.widgets.*;
030
031/**
032 * Builder twins of the Pets pages: P2 Pets ({@code pets.ftlh}), its {@code ?mixed} variant, P3 Sold
033 * ({@code pets-sold.ftlh}) and P4 one pet ({@code pet.ftlh}).
034 *
035 * <h2 class='section'>Example:</h2>
036 * <p class='bjava'>
037 *    <jk>return</jk> <jsm>twin</jsm>(<jv>req</jv>, PetsPageBuilders.<jsm>pets</jsm>());
038 * </p>
039 */
040@SuppressWarnings({
041   "java:S1192" // Page-definition ids and labels repeat as inline literals by design.
042})
043public final class PetsPageBuilders {
044
045   /**
046    * The edit-pet dialog action, shared by the Pets table row menu and the Store page treemap so the two cannot drift.
047    *
048    * @param onSuccess What the page does after a saved edit; a table merges the row, a chart (which has no row) redraws.
049    * @return The action.
050    */
051   static RowAction editPetAction(OnSuccess onSuccess) {
052      return RowAction.create("edit").label("Edit").form("/console/pets/form?id={id}").present(Present.DIALOG)
053         .endpoint("/console/pets/{id}").method(Method.PUT).onSuccess(onSuccess);
054   }
055
056   private PetsPageBuilders() {}
057
058   /**
059    * P2 Pets.
060    *
061    * @return The page spec.
062    */
063   public static PageSpec pets() {
064      return PageSpec.create().tab("pets").toolkit("views", "datatables-buttons", "datatables-export").table(petsTable(), "Pets");
065   }
066
067   /**
068    * P2 Pets, half FTL: {@code pets-mixed.ftlh} lays out the page and places this spec's table with
069    * {@code <@card ref="pets"/>}.
070    *
071    * @return The page spec.
072    */
073   public static PageSpec petsMixed() {
074      return PageSpec.create().template("pets-mixed.ftlh").table(petsTable(), "Pets");
075   }
076
077   /**
078    * The P2 table, shared by {@link #pets()} and {@link #petsMixed()} so the two cannot drift.
079    *
080    * @return A new table spec.
081    */
082   static TableSpec petsTable() {
083      var selection = SelectionDef.create("id").selectAll(true).scope(SelectionDef.Scope.PERSISTENT).labelField("name")
084         .selectableWhen(RowActionEnabledRule.of("status", Op.NE, "SOLD", "Already sold."));
085      return TableSpec.create("pets").rowType("Pet").dataMode(DataMode.SERVER).dataUrl("/console/pets/query")
086         .columnConfig(true)
087         .operators(SearchOperatorSet.standard())
088         .urlState("ids")
089         .defaultOrder("id", Sort.ASC)
090         .pollIntervalMs(30_000)
091         .pausePollingWhileEditing(true)
092         .columns(
093            Column.create("id").label("Id").searchType(SearchType.NUMERIC),
094            Column.create("name").label("Name").href("/console/pets/{id}/summary").searchType(SearchType.TEXT),
095            Column.create("species").label("Species").render(PillRenders.species()).searchType(SearchType.ENUM),
096            Column.create("status").label("Status").render(PillRenders.petStatus()).searchType(SearchType.ENUM),
097            Column.create("price").label("Price (USD)").render(Render.of("decimal").meta("places", 2)),
098            Column.create("tags").label("Tags").defaultVisible(false))
099         .rowClass("status", Op.EQ, "SOLD", "is-muted")
100         .detail(RowDetails.pet())
101         .ribbon(Ribbons.standard()
102            .create(RibbonItem.dialog("add-pet").title("+ Add pet").symbol("plus")
103               .form("/console/pets/form").endpoint("/console/pets").method(Method.POST).onSuccess(OnSuccess.REDRAW))
104            .filter(
105               RibbonItem.optionGroup("status",
106                  RibbonItem.option("available").title("Available").symbol("circle_check").column("status").value("$eq(AVAILABLE)"),
107                  RibbonItem.option("pending").title("Pending").symbol("hourglass").column("status").value("$eq(PENDING)"))
108                  .title("Pet status").deselectable(true).defaultOption("available"),
109               RibbonItem.optionGroup("species",
110                  RibbonItem.option("mammals").title("Mammals").symbol("paw_print").column("species").value("$in(DOG,CAT,MOUSE,RABBIT)"),
111                  RibbonItem.option("others").title("Others").symbol("shapes").column("species").value("$in(BIRD,FISH,SNAKE)"))
112                  .title("Species").deselectable(true).defaultOption("mammals"))
113            .export("excel", "pdf")
114            .build())
115         .rowActions(
116            editPetAction(OnSuccess.MERGE_ROW),
117            RowAction.create("delete").label("Delete").endpoint("/console/pets/{id}").method(Method.DELETE)
118               .confirm("Delete '{name}'?").confirmLabel("Delete").tone(Tone.DANGER).onSuccess(OnSuccess.REDRAW))
119         .selection(selection)
120         .bulk(BulkMutateDef.create(WritePermit.forCapability("pets.sell"), selection).actions(
121            RowAction.create("sell").label("Mark sold").endpoint("/console/pets/{id}/sell").method(Method.POST).bulkMode(BulkMode.PER_ROW)
122               .confirmTitle("Mark pets sold").confirm("Mark the selected pets sold?").onSuccess(OnSuccess.REDRAW)));
123   }
124
125   /**
126    * P3 Sold.
127    *
128    * @return The page spec.
129    */
130   public static PageSpec sold() {
131      return PageSpec.create().toolkit("views", "datatables-buttons").table(soldTable(), "Sold pets");
132   }
133
134   static TableSpec soldTable() {
135      return TableSpec.create("sold").rowType("Pet").dataMode(DataMode.CLIENT).dataUrl("/console/pets/sold/rows")
136            .columnConfig(true)
137            .detail(RowDetails.soldPet())
138            .columns(
139               Column.create("id").label("Id").searchType(SearchType.NUMERIC),
140               Column.create("name").label("Name").searchType(SearchType.TEXT),
141               Column.create("species").label("Species").render(PillRenders.species()).searchType(SearchType.ENUM),
142               Column.create("price").label("Price (USD)").render(Render.of("decimal").meta("places", 2)).searchType(SearchType.NUMERIC))
143            .ribbon(Ribbons.standard()
144               .filter(RibbonItem.optionGroup("species",
145                  RibbonItem.option("dogs").title("Dogs").symbol("paw_print").column("species").value("$eq(DOG)"),
146                  RibbonItem.option("cats").title("Cats").symbol("shapes").column("species").value("$eq(CAT)"))
147                  .title("Species"))
148               .build());
149   }
150
151   /**
152    * P4 one pet, on one tab.
153    *
154    * @param pet The pet.
155    * @param tab The tab: {@code summary}, {@code photo}, {@code orders} or {@code history}.
156    * @param activeNav The active nav path, {@code pets/p<id>/<tab>} or {@code pets/p<id>/orders/o<orderId>}.
157    * @param order The selected order on the orders tab, or <jk>null</jk>.
158    * @param roles The viewer's roles.
159    * @param apiCsrf The API's CSRF token for the photo upload form, or <jk>null</jk> to render the form without one.
160    * @return The page spec.
161    */
162   public static PageSpec pet(Pet pet, String tab, String activeNav, Order order, List<String> roles, String apiCsrf) {
163      var id = pet.getId();
164      var href = "/console/pets/" + id;
165      var p = PageSpec.create().tab(activeNav).toolkit("views").title(pet.getName())
166         .facts(Map.of("viewer", Map.of("roles", roles)))
167         .navUnder("pets", n -> {
168            var node = n.add("p" + id, pet.getName(), href + "/summary");
169            node.add("summary", "Summary", href + "/summary");
170            node.add("photo", "Photo", href + "/photo");
171            var orders = node.add("orders", "Orders", href + "/orders");
172            if (order != null)
173               orders.add("o" + order.getId(), "Order " + order.getId(), href + "/orders/" + order.getId());
174            node.add("history", "History", href + "/history");
175         });
176      var name = escapeHtml(pet.getName());
177      switch (tab) {
178         case "summary" -> p.table(TableSpec.create("pet").rowType("Pet").dataMode(DataMode.CLIENT).dataUrl(href + "/row")
179            .columns(
180               Column.create("id").label("Id"),
181               Column.create("name").label("Name").render(Render.of("edit").meta("action", "rename").meta("column", "name").meta("input", "text")),
182               Column.create("species").label("Species").render(PillRenders.species()),
183               Column.create("status").label("Status").render(PillRenders.petStatus()),
184               Column.create("price").label("Price (USD)").render(Render.of("edit").meta("action", "reprice").meta("column", "price").meta("input", "number")))
185            .rowActions(
186               stage("rename", "Rename"),
187               stage("reprice", "Reprice"),
188               RowAction.create("sell").label("Mark sold").endpoint("/console/pets/{id}/sell").method(Method.POST).onSuccess(OnSuccess.REDRAW)
189                  .confirm("Mark '{name}' sold?").visibleWhen(VisibilityRule.when("status").ne("SOLD")))
190            .ribbon(RibbonItem.refresh()), pet.getName());
191         case "photo" -> {
192            p.html("photo", "Photo", """
193               <figure class="jc-figure">
194               <object data="/petstore/pets/%1$s/photo" type="image/png" aria-label="Photo of %2$s"><p>No photo uploaded for %2$s yet.</p></object>
195               <figcaption>Served by <code>PetPhotoSerializer</code> from <code>GET /petstore/pets/%1$s/photo</code>.</figcaption>
196               </figure>""".formatted(id, name));
197            if (roles.contains("admin")) {
198               var csrf = apiCsrf == null ? "" : " data-petstore-csrf=\"%s\"".formatted(escapeHtml(apiCsrf));
199               p.html("photo-upload", "Upload photo", """
200                  <form class="jc-form" data-petstore-upload="/petstore/pets/%s/photo"%s>
201                  <input type="file" name="photo" accept="image/png,image/jpeg" aria-label="Photo file">
202                  <button type="submit" class="jc-button">Upload</button>
203                  </form>""".formatted(id, csrf));
204            }
205         }
206         case "orders" -> {
207            p.table(TableSpec.create("pet-orders").rowType("Order").dataMode(DataMode.CLIENT).dataUrl(href + "/orders/rows")
208               .columns(
209                  Column.create("id").label("Order").href(href + "/orders/{id}"),
210                  Column.create("shipDate").label("Ship date"),
211                  Column.create("status").label("Status").render(PillRenders.orderStatus()))
212               .detail(RowDetail.create(href + "/orders/{id}/detail").title("Order {id}")), "Orders");
213            if (order != null)
214               p.html("order", "Order " + order.getId(),
215                  "<dl class=\"jc-details\"><dt>Status</dt><dd>%s</dd><dt>Ship date</dt><dd>%s</dd><dt>Pet</dt><dd>%s</dd></dl>"
216                     .formatted(order.getStatus(), escapeHtml(order.getShipDate() == null ? "" : order.getShipDate()), name));
217         }
218         default -> p.table(TableSpec.create("history").rowType("AuditEntry").dataMode(DataMode.CLIENT).dataUrl(href + "/history/rows")
219            .defaultOrder("at", Sort.DESC)
220            .detail(RowDetails.history())
221            .columns(
222               Column.create("id").label("Id").defaultVisible(false),
223               Column.create("at").label("When").render("timestamp"),
224               Column.create("actor").label("Actor"),
225               Column.create("action").label("Action").render(PillRenders.auditAction()),
226               Column.create("detail").label("Detail")), "History");
227      }
228      return p;
229   }
230
231   // The pencil edit cell commits it; present=inline keeps it out of the row menu.
232   private static RowAction stage(String id, String label) {
233      return RowAction.create(id).label(label).endpoint("/console/pets/{id}/stage").method(Method.POST).noConfirm()
234         .present(Present.INLINE)
235         .visibleWhen(VisibilityRule.when("status").ne("SOLD"));
236   }
237}