VisualModePanmirrorContext.java

/*
 * VisualModePanmirrorContext.java
 *
 * Copyright (C) 2021 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant
 * to the terms of a commercial license agreement with RStudio, then
 * this program is licensed to you under the terms of version 3 of the
 * GNU Affero General Public License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
 *
 */


package org.rstudio.studio.client.workbench.views.source.editors.text.visualmode;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;

import com.google.gwt.core.client.GWT;
import org.rstudio.core.client.BrowseCap;
import org.rstudio.core.client.JsArrayUtil;
import org.rstudio.core.client.StringUtil;
import org.rstudio.core.client.XRef;
import org.rstudio.core.client.files.FileSystemItem;
import org.rstudio.core.client.jsinterop.JsVoidFunction;
import org.rstudio.studio.client.RStudioGinjector;
import org.rstudio.studio.client.application.Desktop;
import org.rstudio.studio.client.application.events.EventBus;
import org.rstudio.studio.client.common.FilePathUtils;
import org.rstudio.studio.client.common.SimpleRequestCallback;
import org.rstudio.studio.client.panmirror.PanmirrorContext;
import org.rstudio.studio.client.panmirror.ui.PanmirrorUIContext;
import org.rstudio.studio.client.panmirror.ui.PanmirrorUIDisplay;
import org.rstudio.studio.client.quarto.QuartoHelper;
import org.rstudio.studio.client.quarto.model.QuartoConfig;
import org.rstudio.studio.client.rmarkdown.model.RMarkdownServerOperations;
import org.rstudio.studio.client.workbench.WorkbenchContext;
import org.rstudio.studio.client.workbench.model.BlogdownConfig;
import org.rstudio.studio.client.workbench.model.Session;
import org.rstudio.studio.client.workbench.model.SessionInfo;
import org.rstudio.studio.client.workbench.views.files.events.FileChangeEvent;
import org.rstudio.studio.client.workbench.views.source.ViewsSourceConstants;
import org.rstudio.studio.client.workbench.views.source.editors.text.ImagePreviewer;
import org.rstudio.studio.client.workbench.views.source.editors.text.TextEditingTarget;
import org.rstudio.studio.client.workbench.views.source.events.XRefNavigationEvent;
import org.rstudio.studio.client.workbench.views.source.model.DocUpdateSentinel;

import com.google.gwt.core.client.JsArrayString;
import com.google.inject.Inject;

import elemental2.promise.Promise;
import elemental2.promise.Promise.PromiseExecutorCallbackFn.RejectCallbackFn;
import elemental2.promise.Promise.PromiseExecutorCallbackFn.ResolveCallbackFn;


public class VisualModePanmirrorContext
{

   public VisualModePanmirrorContext(DocUpdateSentinel docUpdateSentinel,
                                     TextEditingTarget target,
                                     VisualModeChunks chunks,
                                     VisualModePanmirrorFormat format,
                                     VisualModeSpelling spelling)
   {
      RStudioGinjector.INSTANCE.injectMembers(this);
      docUpdateSentinel_ = docUpdateSentinel;
      target_ = target;
      chunks_ = chunks;
      format_ = format;
      spelling_ = spelling;
   }

   @Inject
   void initialize(WorkbenchContext workbenchContext, Session session, EventBus events, RMarkdownServerOperations server)
   {
      workbenchContext_ = workbenchContext;
      sessionInfo_ = session.getSessionInfo();
      events_ = events;
      server_ = server;

      // notify watchers of file changes
      events.addHandler(FileChangeEvent.TYPE, new FileChangeEvent.Handler() {
         @Override
         public void onFileChange(FileChangeEvent event)
         {
            fileWatchers_.forEach(fileWatcher -> {
               fileWatcher.onFileChanged(event.getFileChange().getFile());
            });
         }
      });
   }

   public PanmirrorContext createContext(PanmirrorUIDisplay.ShowContextMenu showContextMenu)
   {
      return new PanmirrorContext(
         uiContext(),
         uiDisplay(showContextMenu),
         chunks_.uiChunks(),
         spelling_.uiSpelling()
      );
   }

   private PanmirrorUIContext uiContext()
   {
      PanmirrorUIContext uiContext = new PanmirrorUIContext();

      uiContext.isActiveTab = () -> {
         return target_.isActivated();
      };

      uiContext.getDocumentPath = () -> {
        return docUpdateSentinel_.getPath();
      };

      uiContext.withSavedDocument = () -> {
         return new Promise<>((ResolveCallbackFn<Boolean> resolve, RejectCallbackFn reject) -> {
           target_.withSavedDoc(() -> {
              resolve.onInvoke(true);
           });
         });
      };

      uiContext.getDefaultResourceDir = () -> {
         if (docUpdateSentinel_.getPath() != null)
            return FileSystemItem.createDir(docUpdateSentinel_.getPath()).getParentPathString();
         else
            return workbenchContext_.getCurrentWorkingDir().getPath();
      };

      uiContext.mapPathToResource = path -> {
         FileSystemItem resourceDir = FileSystemItem.createDir(uiContext.getDefaultResourceDir.get());
         FileSystemItem file = FileSystemItem.createFile(path);
         String resourcePath = file.getPathRelativeTo(resourceDir);
         if (resourcePath != null)
         {
            return resourcePath;
         }
         
         String hugoAsset = pathToHugoAsset(path);
         if (hugoAsset != null)
         {
            return hugoAsset;
         }
         else
         {
            return pathToQuartoSiteAsset(path);
         }
      };

      uiContext.mapResourceToURL = path -> {
         path = resolvePath(path);
         FileSystemItem resourceDir = FileSystemItem.createDir(uiContext.getDefaultResourceDir.get());
         return ImagePreviewer.imgSrcPathFromHref(resourceDir.getPath(), path);
      };

      uiContext.watchResource = (path, notify) -> {
         String resourcePath = resolvePath(path);
         if (FilePathUtils.pathIsRelative(resourcePath))
         {
            FileSystemItem resourceDir = FileSystemItem.createDir(uiContext.getDefaultResourceDir.get());
            resourcePath = resourceDir.completePath(resourcePath);
         }
         FileWatcher watcher = new FileWatcher(FileSystemItem.createFile(resourcePath), notify);
         fileWatchers_.add(watcher);
         return () -> {
            fileWatchers_.remove(watcher);
         };
      };


      uiContext.translateText = text -> {
         return text;
      };


      uiContext.droppedUris = () -> {
        if (Desktop.isDesktop() && !Desktop.isRemoteDesktop())
        {
           List<String> uris = workbenchContext_.getDroppedUrls();
           if (uris != null)
              return JsArrayUtil.createStringArray(uris);
           else
              return null;
        }
        else
        {
           return null;
        }
      };

      uiContext.clipboardUris = () -> {
         return new Promise<>((ResolveCallbackFn<JsArrayString> resolve, RejectCallbackFn reject) -> {
           if (Desktop.isDesktop() && !Desktop.isRemoteDesktop())
           {
              Desktop.getFrame().getClipboardUris(uris -> {
                 resolve.onInvoke(uris);
              });
           }
           else
           {
              resolve.onInvoke((JsArrayString)null);
           }
         });
      };

      uiContext.clipboardImage = () -> {
         return new Promise<>((ResolveCallbackFn<String> resolve, RejectCallbackFn reject) -> {
            if (Desktop.isDesktop() && !Desktop.isRemoteDesktop())
            {
               Desktop.getFrame().getClipboardImage(image -> {
                  if (!StringUtil.isNullOrEmpty(image))
                     resolve.onInvoke(image);
                  else
                     resolve.onInvoke((String)null);
               });
            }
            else
            {
               resolve.onInvoke((String)null);
            }
          });
      };

      uiContext.resolveImageUris = (imageUris) -> {
         return new Promise<>((ResolveCallbackFn<JsArrayString> resolve, RejectCallbackFn reject) -> {

            JsArrayString resolvedUris = JsArrayString.createArray().cast();
            JsArrayString unresolvedUris = JsArrayString.createArray().cast();
            for (int i=0; i<imageUris.length(); i++)
            {
               String uri = imageUris.get(i);
               if (isHttpURL(uri))
               {
                  resolvedUris.push(uri);
               }
               else
               {
                  String path = uiContext.mapPathToResource.map(uri);
                  if (path != null)
                  {
                     resolvedUris.push(path);
                  }
                  else
                  {
                     unresolvedUris.push(uri);
                  }
               }
            }

            // import unresolved uris
            if (unresolvedUris.length() > 0)
            {
               FileSystemItem resourceDir = FileSystemItem.createDir(uiContext.getDefaultResourceDir.get());
               String imagesDir = resourceDir.completePath(constants_.images());
               server_.rmdImportImages(unresolvedUris, imagesDir, new SimpleRequestCallback<JsArrayString>() {
                  @Override
                  public void onResponseReceived(JsArrayString importedUris)
                  {
                     for (int i=0; i<importedUris.length(); i++)
                     {
                        String path = uiContext.mapPathToResource.map(importedUris.get(i));
                        if (path != null)
                           resolvedUris.push(path);
                     }
                     resolve.onInvoke(resolvedUris);
                  }
               });
            }
            // no unresolved, continue on
            else
            {
               resolve.onInvoke(resolvedUris);
            }
         });
      };


      uiContext.isWindowsDesktop = () -> {
         return BrowseCap.isWindowsDesktop();
      };

      return uiContext;
   }

   private native boolean isHttpURL(String url)  /*-{
      try {
         url = new URL(url);
         return url.protocol === "http:" || url.protocol === "https:";
      } catch (_) {
         return false;
      }
      return true;
   }-*/;

   private PanmirrorUIDisplay uiDisplay(PanmirrorUIDisplay.ShowContextMenu showContextMenu)
   {
      PanmirrorUIDisplay uiDisplay = new PanmirrorUIDisplay();
      uiDisplay.showContextMenu = showContextMenu;
      uiDisplay.navigateToXRef = (String file, XRef xref) ->
      {
         FileSystemItem srcFile = FileSystemItem.createFile(file);
         events_.fireEvent(new XRefNavigationEvent(xref, srcFile, true));
      };

      return uiDisplay;
   }

   private String pathToHugoAsset(String path)
   {
      if (format_.isHugoProjectDocument())
      {
         FileSystemItem file = FileSystemItem.createFile(path);
         for (FileSystemItem dir : hugoStaticDirs())
         {
            String assetPath = file.getPathRelativeTo(dir);
            if (assetPath != null)
               return "/" + assetPath;
         }

         return null;
      }
      else
      {
         return null;
      }
   }
   
   private String pathToQuartoSiteAsset(String path)
   {
      QuartoConfig config = sessionInfo_.getQuartoConfig();
      if (QuartoHelper.isQuartoWebsiteDoc(path, config))
      {
         FileSystemItem file = FileSystemItem.createFile(path);
         FileSystemItem siteDir = FileSystemItem.createDir(config.project_dir);
         String assetPath = file.getPathRelativeTo(siteDir);
         if (assetPath != null)
            return "/" + assetPath;
      }
      
      return null;
   }

   private String resolvePath(String path)
   {
      String hugoPath = hugoAssetPath(path);
      if (hugoPath != null)
         return hugoPath;
      
      String quartoPath = quartoSiteAssetPath(path);
      if (quartoPath != null)
         return quartoPath;
      
      return path;
   }


   // TODO: currently can only serve image preview out of main static dir
   // (to resolve we'd need to create a server-side handler that presents
   // a union view of the various static dirs, much as hugo does internally)
   private String hugoAssetPath(String asset)
   {
      if (format_.isHugoProjectDocument() && asset.startsWith("/"))
      {
         return hugoStaticDirs().get(0).completePath(asset.substring(1));
      }
      else
      {
         return null;
      }
   }
   
   private String quartoSiteAssetPath(String asset)
   {
      QuartoConfig config = sessionInfo_.getQuartoConfig();
      if (format_.isQuartoDocument() && 
          asset.startsWith("/") && 
          QuartoHelper.isQuartoWebsiteConfig(config))
      {
         return FileSystemItem.createDir(config.project_dir).completePath(asset.substring(1));
      }
      else
      {
         return null;
      }
   }


   private List<FileSystemItem> hugoStaticDirs()
   {
      FileSystemItem siteDir = getBlogdownConfig().site_dir;
      List<FileSystemItem> staticDirs = new ArrayList<>();
      for (String dir : getBlogdownConfig().static_dirs)
         staticDirs.add(FileSystemItem.createDir(siteDir.completePath(dir)));
      return staticDirs;

   }


   private BlogdownConfig getBlogdownConfig()
   {
      return sessionInfo_.getBlogdownConfig();
   }



   private class FileWatcher
   {
      public FileWatcher(FileSystemItem file, JsVoidFunction notify)
      {
         file_ = file;
         notify_ = notify;
      }

      public void onFileChanged(FileSystemItem file)
      {
         if (file.equalTo(file_))
            notify_.call();
      }

      private FileSystemItem file_;
      private JsVoidFunction notify_;
   }
   private HashSet<FileWatcher> fileWatchers_ = new HashSet<>();

   private final DocUpdateSentinel docUpdateSentinel_;
   private final TextEditingTarget target_;

   private final VisualModePanmirrorFormat format_;
   private final VisualModeChunks chunks_;
   private final VisualModeSpelling spelling_;

   private WorkbenchContext workbenchContext_;
   private SessionInfo sessionInfo_;
   private EventBus events_;
   private RMarkdownServerOperations server_;
   private static final ViewsSourceConstants constants_ = GWT.create(ViewsSourceConstants.class);
}