/* 
    P/P   *  Method: com.dmdirc.addons.ui_swing.actions.SanitisedFilenamePasteAction__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.addons.ui_swing.actions;
    24  
    25  import com.dmdirc.logger.ErrorLevel;
    26  import com.dmdirc.logger.Logger;
    27  
    28  import java.awt.Toolkit;
    29  import java.awt.datatransfer.DataFlavor;
    30  import java.awt.datatransfer.UnsupportedFlavorException;
    31  import java.awt.event.ActionEvent;
    32  import java.io.IOException;
    33  
    34  import javax.swing.AbstractAction;
    35  import javax.swing.text.JTextComponent;
    36  
    37  /**
    38   * Paste action that sanitises filenames
    39   */
    40  public final class SanitisedFilenamePasteAction extends AbstractAction {
    41      
    42      /**
    43       * A version number for this class. It should be changed whenever the class
    44       * structure is changed (or anything else that would prevent serialized
    45       * objects being unserialized with the new class).
    46       */
    47      private static final long serialVersionUID = 1;
    48      
    49      /** Invalid filename characters. */
    50      private static final String INVALID_CHARS = "^[^\\w\\.\\s\\-\\#\\&\\_]";
    51      
    52      /**
    53       * Creates a new instance of SanitisedFilenamePasteAction.
    54       */
    55      public SanitisedFilenamePasteAction() {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.actions.SanitisedFilenamePasteAction()
                  */
    56          super("NoSpacesPasteAction");
    57      }
    58      
    59      /**
    60       * {@inheritDoc}
    61       *
    62       * @param e Action event
    63       */
    64      @Override
    65      public void actionPerformed(final ActionEvent e) {
    66          final JTextComponent comp;
    67          
                 /* 
    P/P           *  Method: void actionPerformed(ActionEvent)
                  * 
                  *  Preconditions:
                  *    e != null
                  * 
                  *  Presumptions:
                  *    init'ed(com.dmdirc.logger.ErrorLevel.LOW)
                  *    java.awt.Toolkit:getDefaultToolkit(...)@76 != null
                  *    java.awt.Toolkit:getDefaultToolkit(...)@83 != null
                  *    java.awt.Toolkit:getSystemClipboard(...)@76 != null
                  *    java.awt.Toolkit:getSystemClipboard(...)@83 != null
                  *    ...
                  * 
                  *  Test Vectors:
                  *    java.awt.datatransfer.Clipboard:isDataFlavorAvailable(...)@76: {1}, {0}
                  */
    68          if (e.getSource() instanceof JTextComponent) {
    69              comp = (JTextComponent) e.getSource();
    70          } else {
    71              return;
    72          }
    73          
    74          String clipboard = null;
    75          
    76          if (!Toolkit.getDefaultToolkit().getSystemClipboard().
    77                  isDataFlavorAvailable(DataFlavor.stringFlavor)) {
    78              return;
    79          }
    80          
    81          try {
    82              //get the contents of the clipboard
    83              clipboard = (String) Toolkit.getDefaultToolkit().
    84                      getSystemClipboard().getData(DataFlavor.stringFlavor);
    85              //remove invalid letters
    86              clipboard = clipboard.replaceAll(INVALID_CHARS, "");
    87              
    88              //insert the contents at the current cursor position
    89          comp.replaceSelection(clipboard);
    90          } catch (IOException ex) {
    91              Logger.userError(ErrorLevel.LOW, "Unable to get clipboard contents: " + ex.getMessage());
    92          } catch (UnsupportedFlavorException ex) {
    93              Logger.appError(ErrorLevel.LOW, "Unable to get clipboard contents", ex);
    94          }
    95      }
    96      
    97  }