Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,23 @@
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Noah Ortega
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

NMSVRScreenshotFix.java

@@ -0,0 +1,287 @@
+
+package nmsvrscreenshotfix;
+
+import java.io.IOException;
+import java.io.File;
+import java.awt.image.BufferedImage;
+import javax.imageio.ImageIO;
+import java.awt.Graphics2D;
+import static java.lang.Character.isLetterOrDigit;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Iterates through every image in the executable's folder and if applicable, 
+ * creates a copy of it with an aspect ratio to 1:1
+ * @author Noah Ortega
+ */
+public class NMSVRScreenshotFix {    
+
+    public static void main(String[] args) {
+        LogicController.getInstance();
+    }
+}
+
+class LogicController {
+
+    public boolean isExecuting = false;
+    public boolean canceled = false;
+
+    private int totalFiles;
+    private int converted;
+    private BufferedImage curImage;
+
+    public String sourcePath;
+    public String resultPath;
+
+    public boolean shouldRename = true;
+    public boolean renameNewFile = true;
+    public String addToFile = "_fix";
+    public boolean addAsPrefix = false;
+
+    ProgramUI myUI;
+
+    //singleton
+    private static LogicController sharedController = null;
+    private LogicController() {
+        launchUI();
+        sourcePath = System.getProperty("user.dir");
+        resultPath = System.getProperty("user.dir");
+    }
+    public static LogicController getInstance() {
+        if(sharedController == null) {
+            sharedController = new LogicController();
+        }
+        return sharedController;
+    }
+
+
+    private void launchUI() {
+        /* Set the Nimbus look and feel */
+        //<editor-fold defaultstate="collapsed" desc=" Look and feel setting code (optional) ">
+        /* If Nimbus (introduced in Java SE 6) is not available, stay with the default look and feel.
+         * For details see http://download.oracle.com/javase/tutorial/uiswing/lookandfeel/plaf.html 
+         */
+        try {
+            for (javax.swing.UIManager.LookAndFeelInfo info : javax.swing.UIManager.getInstalledLookAndFeels()) {
+                if ("Nimbus".equals(info.getName())) {
+                    javax.swing.UIManager.setLookAndFeel(info.getClassName());
+                    break;
+                }
+            }
+        } catch (ClassNotFoundException ex) {
+            java.util.logging.Logger.getLogger(ProgramUI.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
+        } catch (InstantiationException ex) {
+            java.util.logging.Logger.getLogger(ProgramUI.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
+        } catch (IllegalAccessException ex) {
+            java.util.logging.Logger.getLogger(ProgramUI.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
+        } catch (javax.swing.UnsupportedLookAndFeelException ex) {
+            java.util.logging.Logger.getLogger(ProgramUI.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
+        }
+        //</editor-fold>
+        //</editor-fold>
+        //</editor-fold>
+        //</editor-fold>
+
+        /* Create and display the form */
+        java.awt.EventQueue.invokeLater(new Runnable() {
+            public void run() {
+               myUI = new ProgramUI();
+               myUI.setVisible(true);
+            }
+        });
+    }   
+
+    /**
+     * Iterates through the files in the directory, validates files before 
+     * allowing resizing.
+     */
+    public void execute() {
+        System.out.println("starting");
+        isExecuting = true;
+        canceled = false;
+        myUI.updateProgressBar(0);
+        converted = 0;
+
+        File sourceFolder = new File(sourcePath); //file of originals
+        File destFolder = new File(resultPath); //destination files
+
+        File[] folderContents = sourceFolder.listFiles();
+        totalFiles = folderContents.length;
+        File curFile;
+
+
+        for (int fileIndex = 0; fileIndex < totalFiles && !canceled; fileIndex++) {
+            curFile = folderContents[fileIndex];
+            if (!folderContents[fileIndex].isDirectory() && isImage(curFile.getPath())) {
+                System.out.println(fileIndex);
+                //System.out.println(curFile.getPath());
+                try {
+                    curImage = ImageIO.read(folderContents[fileIndex]);
+                    if (shouldResize(curImage.getWidth(), curImage.getHeight())) {
+                        squish(curFile);
+                        converted++;
+                    }
+                } 
+                catch (IOException ex) {
+                    System.err.println(">> Caught IOException on '" + curFile.getPath() + "':\n  " + ex.getMessage());
+                }
+            }
+            myUI.updateProgressBar((fileIndex + 1)*100/totalFiles);
+        }
+        if(canceled) {myUI.cancelPopup(converted);}
+        else {myUI.successPopup(converted);}
+
+        isExecuting = false;
+        System.out.println("finished");
+    }
+
+     /**
+     * Resizes an image to a 1:1 aspect ratio by changing the width
+     * @param originalFile Path of the original input image
+     * @throws java.io.IOException
+     * 
+     * based on code by Nam Ha Minh from article "How to resize images in Java"
+     * https://www.codejava.net/java-se/graphics/how-to-resize-images-in-java
+     */
+    private void squish(File originalFile) throws IOException {
+        int newWidth = curImage.getHeight();
+        int height = curImage.getHeight();
+        // creates output image
+        BufferedImage outputImage = new BufferedImage(newWidth, height, curImage.getType());
+
+        // scales the input image to the output image
+        Graphics2D g2d = outputImage.createGraphics();
+        g2d.drawImage(curImage, 0, 0, newWidth, height, null);
+        g2d.dispose();
+
+        int fileDotIndex = originalFile.getName().lastIndexOf('.');
+        String formatName = originalFile.getName().substring(fileDotIndex + 1);
+
+        File newFile = new File(resultPath +"/"+ originalFile.getName());
+        if(shouldRename) {
+            if (renameNewFile) {
+                newFile = modifyFilePath(resultPath,originalFile.getName());
+            }
+            else {
+                originalFile.renameTo(modifyFilePath(sourcePath,originalFile.getName()));
+            }
+        }
+        // write to output file
+        ImageIO.write(outputImage, formatName, newFile);
+
+        System.out.println(">> Converted");
+    }
+
+    public void cancelExecution() {
+        canceled = true;
+    }
+
+    public String getCurrentBehavior() {
+        String behavior = "";
+        if(!shouldRename && (sourcePath.equals(resultPath))) {
+            behavior += "• Replacing originals with converted screenshots";
+        }
+        else {
+            behavior += "• Making copies of converted screenshots";
+        }
+
+        behavior +="\n";
+        if(shouldRename) {
+            if(addAsPrefix) {
+                behavior += "• Adding prefix ";
+            }
+            else {
+                behavior += "• Adding suffix ";
+            }
+            behavior += "\""+addToFile+"\" to ";
+            if(renameNewFile) {
+                behavior += "converted image";
+            }
+            else {
+                behavior += "original image";
+            }
+            behavior += "\n";
+            behavior += "• " + getExampleRename();
+        }
+        return behavior;
+    }
+
+    private String getRename(String oldName) {
+        int dotIndex = oldName.lastIndexOf('.');
+
+        String name = oldName.substring(0, dotIndex);
+        String ext = oldName.substring(dotIndex);
+
+        return addAsPrefix ? (addToFile+name+ext) : (name+addToFile+ext);
+    }
+
+    private String getExampleRename() {
+        String exampleName = renameNewFile ? "converted.png" : "original.png";
+        return ("Ex: \"" + exampleName + "\" -> \"" + getRename(exampleName) +"\"");
+    }  
+
+    private File modifyFilePath(String parentPath, String fileName) {
+        return (new File(parentPath + "/" + getRename(fileName)));
+    }
+
+    /**
+     * Determines if a file is a basic image type
+     * @param path file path of image
+     * @return true if extension is png jpg or jpeg
+     */
+    private boolean isImage(String path) {
+        //extention of file, from file after final period
+        int dotIndex = path.lastIndexOf('.');
+        String extension = (dotIndex == -1) ? "no extension" : path.substring(dotIndex + 1);
+        extension = extension.toLowerCase();
+        return (extension.equals("png") || extension.equals("jpg") || extension.equals("jpeg"));
+    }
+
+    /**
+     * Determines if an image should be resized based on criteria:
+     * - width must be greater than height
+     * @param width image width
+     * @param height image height
+     * @return true if image matches criteria
+     */
+    private boolean shouldResize(int width, int height) {
+        if (width == height) {
+            System.out.println(">> Already 1:1 aspect ratio");
+            return false;
+        } else if (width < height) {
+            System.out.println(">> Height is greater than width");
+            return false;
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * For generating the path of the output image
+     * @param inputPath Path of the original input image
+     * @param dotIndex the index of the dot in the input path
+     * @return the final output path
+     */
+    public String generateOutputPath(String inputPath, int dotIndex) {
+
+        return inputPath.substring(0, dotIndex) + addToFile + inputPath.substring(dotIndex);
+    }
+
+    public boolean isValidAddition(String phrase) {
+
+        for (int charIndex = 0; charIndex < phrase.length(); charIndex++) {
+            char curChar = phrase.charAt(charIndex);
+            if(!isLetterOrDigit(curChar)) {
+                if(curChar != '_' && curChar != '-') {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    public boolean hasValidDirectoryPaths() {
+        return((new File(sourcePath)).isDirectory() && (new File(resultPath)).isDirectory());
+    }
+}