WikiEditor.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2015 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.zkoss.text;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.turro.command.Command;
import org.turro.command.Context;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.impl.util.FileUtil;
import org.turro.elephant.impl.util.Parser;
import org.turro.elephant.util.Components;
import org.turro.i18n.I_;
import org.turro.parser.wiki.WikiProcessors;
import org.turro.wiki.WikiParser;
import org.turro.wiki.WikiResult;
import org.turro.wiki.parsing.IWikiResolver;
import org.turro.zkoss.dialog.SelectionDialog;
import org.turro.zkoss.input.FileListbox;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.IdSpace;
import org.zkoss.zk.ui.annotation.ComponentAnnotation;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.event.InputEvent;
import org.zkoss.zk.ui.select.Selectors;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zul.Div;
import org.zkoss.zul.Grid;
import org.zkoss.zul.Html;
import org.zkoss.zul.ListModelArray;
import org.zkoss.zul.Menubar;
import org.zkoss.zul.Menuitem;
import org.zkoss.zul.South;
import org.zkoss.zul.Textbox;
 
@ComponentAnnotation({"value:@ZKBIND(ACCESS=both,SAVE_EVENT=onChange)"})
public class WikiEditor extends Div implements IdSpace {
 
  private int selectionStart, selectionEnd;
  private String imageFolder = "/", fileFolder = "/";
  private boolean readOnlyRepository = false, noTreeRepository = false;
  private final List<IWikiResolver> resolvers = new ArrayList<>();
  
  @Wire private Menubar wikibar;
  @Wire private WikiTextbox wikibox;
  @Wire private Grid output;
  @Wire private Menuitem elwiki;
  @Wire private South outpanel;
  
  public WikiEditor() {
    setSclass("wikiEditor");
    Executions.createComponents("/WEB-INF/_zul/bs/comps/editor/wikiInput.zul", this, null);
    Selectors.wireComponents(this, this, false);
    Selectors.wireEventListeners(this, this);
        wikibox.setWidgetListener("onClick", 
                "zAu.send(new zk.Event(this,\"onCaret\",zk(this.$n()).getSelectionRange()+\"\",{toServer:true}));");
        wikibox.setWidgetListener("onBlur", 
                "zAu.send(new zk.Event(this,\"onCaret\",zk(this.$n()).getSelectionRange()+\"\",{toServer:true}));");
        wikibox.setWidgetListener("onSelection", 
                "zAu.send(new zk.Event(this,\"onCaret\",zk(this.$n()).getSelectionRange()+\"\",{toServer:true}));");
        wikibox.setWidgetListener("onChanging", 
                "zAu.send(new zk.Event(this,\"onCaret\",zk(this.$n()).getSelectionRange()+\"\",{toServer:true}));");
    wikibox.addEventListener(Events.ON_CHANGE, new EventListener<InputEvent>() {
      @Override
      public void onEvent(InputEvent event) throws Exception {
        Events.postEvent(WikiEditor.this, event);
      }
    });
  }
 
  public void setValue(String value) {
    setWiki(value);
    elwiki.setCheckmark(WikiParser.isElWiki(value));
  }
  
  public String getValue() {
    return wikibox.getValue();
  }
  
  public String getHtml() {
    return getHtml(wikibox.getValue(), false);
  }
  
  public void setImageFolder(String folder) {
    this.imageFolder = folder;
  }
 
  public String getImageFolder() {
    return imageFolder;
  }
 
  public void setFileFolder(String folder) {
    this.fileFolder = folder;
  }
  
  public String getFileFolder() {
    return fileFolder;
  }
  
  public boolean isReadonly() {
    return wikibox.isReadonly();
  }
  
  public void setReadonly(boolean value) {
    wikibox.setReadonly(value);
    for(Object obj : wikibar.getChildren()) {
      if(obj instanceof Menuitem) {
        ((Menuitem) obj).setDisabled(value);
      }
    }
  }
 
  public boolean isReadOnlyRepository() {
    return readOnlyRepository;
  }
 
  public void setReadOnlyRepository(boolean readOnlyRepository) {
    this.readOnlyRepository = readOnlyRepository;
  }
 
  public boolean isNoTreeRepository() {
    return noTreeRepository;
  }
 
  public void setNoTreeRepository(boolean noTreeRepository) {
    this.noTreeRepository = noTreeRepository;
  }
  
  public boolean isElWiki() {
    return elwiki.isCheckmark();
  }
  
  public void addResolver(IWikiResolver resolver) {
    if(resolver != null) resolvers.add(resolver);
  }
  
  @Listen("onCaret = *")
  public void onCaret(Event event) {
    String v[] = ((String) event.getData()).split(",");
    selectionStart = Integer.valueOf(v[0]);
    selectionEnd = Integer.valueOf(v[1]);
  }
  
  @Listen("onClick = #header1")
  public void onHeader1() {
    insertOnStartLine("---+", new String[] {
      "---++++", "---+++", "---++", "---+" 
    });
  }
 
  @Listen("onClick = #header2")
  public void onHeader2() {
    insertOnStartLine("---++", new String[] {
      "---++++", "---+++", "---++", "---+" 
    });
  }
 
  @Listen("onClick = #header3")
  public void onHeader3() {
    insertOnStartLine("---+++", new String[] {
      "---++++", "---+++", "---++", "---+" 
    });
  }
 
  @Listen("onClick = #header4")
  public void onHeader4() {
    insertOnStartLine("---++++", new String[] {
      "---++++", "---+++", "---++", "---+" 
    });
  }
 
  @Listen("onClick = #block")
  public void onBlock() {
    insert("\n[block]\n", "\n[/block]\n");
  }
 
  @Listen("onClick = #span")
  public void onSpan() {
    insert("[span]", "[/span]");
  }
 
  @Listen("onClick = #note")
  public void onNote() {
    insert("\n[note]", "[/note]\n");
  }
 
  @Listen("onClick = #startcolumn")
  public void onStartColumn() {
    insert("\n[column]\n");
  }
 
  @Listen("onClick = #endcolumns")
  public void onEndColumns() {
    insert("\n[/column]\n");
  }
 
  @Listen("onClick = #tabulator")
  public void onTabulator() {
    insert("\n[tab(Caption1)]\n","Content1\n[tab(Caption2)]\nContent2\n[/tab]\n");
  }
 
  @Listen("onClick = #blind")
  public void onBlind() {
    insert("\n[blind(Caption1)]\n","Content1\n[blind(Caption2)]\nContent2\n[/blind]\n");
  }
 
  @Listen("onClick = #bold")
  public void onBold() {
    WikiElement we = new WikiElement(selectionStart, selectionEnd, wikibox, WikiElement.NON_BLOCK_ELEMENTS);
    if(selectionStart == selectionEnd && we.inside() && !we.isTag("img")) {
      putAttribute("font-weight", "bold");
    } else {
      insert("**","**", true);
    }
  }
 
  @Listen("onClick = #italic")
  public void onItalic() {
    WikiElement we = new WikiElement(selectionStart, selectionEnd, wikibox, WikiElement.NON_BLOCK_ELEMENTS);
    if(selectionStart == selectionEnd && we.inside() && !we.isTag("img")) {
      putAttribute("font-style", "italic");
    } else {
      insert("__","__", true);
    }
  }
 
  @Listen("onClick = #regular")
  public void onRegular() {
    insert("==","==", true);
  }
 
  @Listen("onClick = #toWiki")
  public void onToWiki() {
    String v = wikibox.getValue();
    String w = Parser.toWiki(v);
    wikibox.setSelectedText(0, v.length(), w, false);
    wikibox.setSelectionRange(0, 0);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
  
  @Listen("onClick = #preview")
  public void onPreview() {
    Div div = new Div();
    div.setStyle("overflow:auto;");
    Html html = new Html(getHtml(wikibox.getValue(), true));
    div.appendChild(html);
    SelectionDialog.showComponent(getPage(), I_.get("Preview"), div, "800px", "80%", null);
  }
  
  @Listen("onClick = #html")
  public void onHtml() {
    Div div = new Div();
    div.setSclass("wikiEditor");
    Textbox html = new Textbox(getHtml(wikibox.getValue(), false));
    html.setSclass("wikiBox");
    html.setReadonly(true);
    html.setMultiline(true);
    html.setHflex("1");
    html.setVflex("1");
    div.appendChild(html);
    SelectionDialog.showComponent(getPage(), "HTML", div, "800px", "80%", null);
  }
  
  @Listen("onClick = #startwiki")
  public void onStartWiki() {
    insert("\n$wiki\n");
  }
  
  @Listen("onClick = #stopwiki")
  public void onStopWiki() {
    insert("\n$no_wiki\n");
  }
  
  @Listen("onClick = #startjava")
  public void onStartJava() {
    insert("\n$java\n");
  }
  
  @Listen("onClick = #stopjava")
  public void onStopJava() {
    insert("\n$no_java\n");
  }
  
  @Listen("onClick = #startxml")
  public void onStartXml() {
    insert("\n$xml\n");
  }
  
  @Listen("onClick = #stopxml")
  public void onStopXml() {
    insert("\n$no_xml\n");
  }
  
  @Listen("onClick = #alignleft")
  public void onAlignLeft() {
    putAttribute("text-align", "left");
  }
  
  @Listen("onClick = #aligncenter")
  public void onAlignCenter() {
    putAttribute("text-align", "center");
  }
  
  @Listen("onClick = #alignright")
  public void onAlignRight() {
    putAttribute("text-align", "right");
  }
  
  @Listen("onClick = #alignjustify")
  public void onAlignJustify() {
    putAttribute("text-align", "justify");
  }
  
  @Listen("onClick = #floatleft")
  public void onFloatLeft() {
    putAttribute("float", "left");
  }
  
  @Listen("onClick = #floatright")
  public void onFloatright() {
    putAttribute("float", "right");
  }
  
  @Listen("onClick = #ullist")
  public void onUlList() {
    insertOnStartLine(" * ", " 1 ");
  }
  
  @Listen("onClick = #ollist")
  public void onOlList() {
    insertOnStartLine(" 1 ", " * ");
  }
  
  @Listen("onClick = #thl")
  public void onThl() {
    insert("\n||<");
  }
  
  @Listen("onClick = #thr")
  public void onThr() {
    insert("\n||>");
  }
  
  @Listen("onClick = #trl")
  public void onTrl() {
    insert("\n|-<");
  }
  
  @Listen("onClick = #trr")
  public void onTrr() {
    insert("\n|->");
  }
  
  @Listen("onClick = #tcl")
  public void onTcl() {
    insert("\n|<");
  }
  
  @Listen("onClick = #tcr")
  public void onTcr() {
    insert("\n|>");
  }
  
  @Listen("onClick = #tet")
  public void onTet() {
    insert("\n-||");
  }
  
  @Listen("onClick = #eraser")
  public void onEraser() {
    removeAttributes();
  }
  
  @Listen("onChange = #color")
  public void onColor(InputEvent event) {
    putAttribute("color", event.getValue());
  }
  
  @Listen("onChange = #background")
  public void onBackground(InputEvent event) {
    putAttribute("background-color", event.getValue());
  }
  
  @Listen("onClick = #link")
  public void onLink() {
    WikiElement we = new WikiElement(selectionStart, selectionEnd, wikibox);
    if(!we.isTag("link")) {
      we.forgetAndCreate("link");
    }
    Link link = new Link(we);
    link.setFileFolder(fileFolder);
    link.setReadOnlyRepository(readOnlyRepository);
    link.setNoTreeRepository(noTreeRepository);
    SelectionDialog.getComponent(Executions.getCurrent().getDesktop().getFirstPage(), "Link", link, "500px", "300px", new Command() {
      @Override
      public Object execute(Context context) {
        Link link = (Link) context.get("component");
        if(link != null && link.renderResult()) {
          wikibox.setSelectionRange(selectionStart, selectionStart);
          wikibox.setFocus(true);
          Events.postEvent(new InputEvent("onChange", WikiEditor.this, wikibox.getValue(), null));
        }
        return null;
      }
    });
  }
  
  @Listen("onClick = #image")
  public void onImage() {
    WikiElement we = new WikiElement(selectionStart, wikibox, "img");
//    if(!we.isTag("img")) {
//      we.forgetAndCreate("img");
//    }
    final RepositoryWalker repositories = new RepositoryWalker(we);
    repositories.selectFolder(imageFolder);
    repositories.setFilter(RepositoryContent.IMAGE_FILTER);
    repositories.setReadOnlyRepository(readOnlyRepository);
    repositories.setNoTreeRepository(noTreeRepository);
    SelectionDialog.showComponent(getPage(), I_.get("Repository"), repositories, "90%", "90%", new Command() {
      @Override
      public Object execute(Context context) {
        if(repositories.renderResult()) {
          wikibox.setSelectionRange(selectionStart, selectionStart);
          wikibox.setFocus(true);
          Events.postEvent(new InputEvent("onChange", WikiEditor.this, wikibox.getValue(), null));
        }
        return null;
      }
    });
  }
  
  @Listen("onClick = #template")
  public void onTemplate() {
    File wtmpl = new File(ElephantContext.getRealPath("/WEB-INF/elephant/wiki/templates"));
    if(wtmpl.exists()) {
      FileListbox fl = new FileListbox();
      fl.setExact(true);
      fl.setFilter(".*\\.wiki");
      fl.setDir(wtmpl);
      fl.addEventListener(Events.ON_DOUBLE_CLICK, (Event event) -> {
        insert(FileUtil.getContentWithLineBreaks(fl.getObjectValue()));
        Events.postEvent(new Event(Events.ON_CLOSE, Components.from(fl).parent(SelectionDialog.class)));
      });
      SelectionDialog.showComponent(getPage(), I_.get("Repository"), fl, "300px", "50%", (Context context) -> {
        if(fl.getObjectValue() != null) {
          wikibox.setFocus(true);
          Events.postEvent(new InputEvent("onChange", WikiEditor.this, wikibox.getValue(), null));
        }
        return null;
      });
    }
  }
  
  @Listen("onClick = #snippet")
  public void onSnippet() {
    File wsnip = new File(ElephantContext.getRealPath("/WEB-INF/elephant/wiki/snippets"));
    if(wsnip.exists()) {
      FileListbox fl = new FileListbox();
      fl.setExact(true);
      fl.setFilter(".*\\.wiki");
      fl.setDir(wsnip);
      fl.addEventListener(Events.ON_DOUBLE_CLICK, (Event event) -> {
        insert(FileUtil.getContentWithLineBreaks(fl.getObjectValue()));
        Events.postEvent(new Event(Events.ON_CLOSE, Components.from(fl).parent(SelectionDialog.class)));
      });
      SelectionDialog.showComponent(getPage(), I_.get("Repository"), fl, "300px", "50%", (Context context) -> {
        if(fl.getObjectValue() != null) {
          wikibox.setFocus(true);
          Events.postEvent(new InputEvent("onChange", WikiEditor.this, wikibox.getValue(), null));
        }
        return null;
      });
    }
  }
  
  @Listen("onClick = #elwiki")
  public void onElWiki() {
    elwiki.setCheckmark(!elwiki.isCheckmark());
  }
 
  private void insert(String string) {
    int start = selectionStart;
    wikibox.setSelectedText(start, start, string, false);
    start += string.length();
    wikibox.setSelectionRange(start, start);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
 
  private void insert(String startTag, String endTag) {
    insert(startTag, endTag, false);
  }
  
  private void insert(String startTag, String endTag, boolean singleLine) {
    int start = selectionStart, end = selectionEnd;
    String value = wikibox.getValue();
    if(singleLine) {
      for(int i = start; i < end; i++) {
        if(value.charAt(i) == '\n') {
          end = i - 1;
          break;
        }
      }
    }
    wikibox.setSelectedText(start, start, startTag, false);
    start += startTag.length();
    end += startTag.length();
    wikibox.setSelectedText(end, end, endTag, false);
    wikibox.setSelectionRange(start, start);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
  
  private void putAttribute(String key, String value) {
    WikiElement we = new WikiElement(selectionStart, selectionEnd, wikibox, WikiElement.NON_BLOCK_ELEMENTS);
    we.getAttributes().put(key, value);
    we.render();
    wikibox.setSelectionRange(selectionStart, selectionStart);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
 
  private void removeAttributes() {
    WikiElement we = new WikiElement(selectionStart, selectionEnd, wikibox, WikiElement.NON_BLOCK_ELEMENTS);
    we.removeValuedAttributes();
    we.render();
    wikibox.setSelectionRange(selectionStart, selectionStart);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
 
  private void insertOnStartLine(String value) {
    insertOnStartLine(value, value);
  }
  
  private void insertOnStartLine(String value, String replacement) {
    insertOnStartLine(value, new String[] { value, replacement });
  }
  
  private void insertOnStartLine(String value, String[] replacement) {
    int start = selectionStart, end = selectionEnd;
    String text = wikibox.getValue();
    // Start with first line
    for(int c = start - 1; c >= 0; c--) {
      if(text.charAt(c) == '\n') {
        int shift = killReplacements(text, c + 1, replacement);
        start += shift;
        end += shift;
        wikibox.setSelectedText(c + 1, c + 1, value, false);
        start += value.length();
        end += value.length();
        break;
      } else if(c == 0) {
        int shift = killReplacements(text, c, replacement);
        start += shift;
        end += shift;
        wikibox.setSelectedText(c, c, value, false);
        start += value.length();
        end += value.length();
        break;
      }
    }
    text = wikibox.getValue();
    // Walk through selection
    for(int c = start; c < end; c++) {
      if(text.charAt(c) == '\n') {
        int shift = killReplacements(text, c + 1, replacement);
        end += shift;
        wikibox.setSelectedText(c + 1, c + 1, value, false);
        end += value.length();
        text = wikibox.getValue();
      } else if(c == 0) {
        int shift = killReplacements(text, c, replacement);
        end += shift;
        wikibox.setSelectedText(c, c, value, false);
        end += value.length();
        text = wikibox.getValue();
      }
    }
    wikibox.setSelectionRange(start, start);
    wikibox.setFocus(true);
    Events.postEvent(new InputEvent("onChange", this, wikibox.getValue(), null));
  }
 
  private int killReplacements(String text, int c, String[] replacement) {
    int shift = 0;
    for(String r : replacement) {
      if(text.substring(c).startsWith(r)) {
        wikibox.setSelectedText(c, c + r.length(), "", false);
        shift -= r.length();
        break;
      }
    }
    return shift;
  }
  
  private void setWiki(String source) {
    elwiki.setCheckmark(false);
    wikibox.setValue(source);
  }
 
  private String getHtml(String source, boolean preview) {
    IConstructor constructor = Application.getApplication().getConstructor();
    String htmlStr;
    output.setModel(new ListModelArray(Collections.EMPTY_LIST));
    elwiki.setCheckmark(elwiki.isCheckmark() || WikiParser.isElWiki(source));
    if(elwiki.isCheckmark()) {
      WikiResult result = WikiParser.instance()
              .onProcessor(wmacro -> WikiProcessors.instance().constructor(constructor).resolve(wmacro))
              .addResolvers(resolvers)
              .parse(wikibox.getValue());
      htmlStr = result.getHtml();
      if(!result.getErrors().isEmpty()) {
        output.setModel(new ListModelArray<>(result.getErrors()));
        outpanel.setOpen(true);
      } else {
        outpanel.setOpen(false);
      }
    } else {
      Parser parser = new Parser("$wiki\n" + wikibox.getValue());
      parser.setResolver(w -> {
        for(IWikiResolver resolver : resolvers) {
          w = resolver.apply(w);
        }
        return w;
      });
      htmlStr = parser.parse(constructor);
    }
    return (preview ? styleSheets() : "") + htmlStr;
  }
  
  private String styleSheets() {
    return "<link rel=\"stylesheet\" type=\"text/css\" href=\"" +
            ElephantContext.getRootWebPath() + "/_internal/css/elephant-theme.css" +
            "\"/>\n";
  }
  
}