Changeset 1148


Ignore:
Timestamp:
Feb 17, 2010, 6:18:35 PM (12 years ago)
Author:
pretzsch
Message:

+ FileInput: New output: File length as int

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/CrypPlugins/FileInput/FileInput.cs

    r893 r1148  
    1 /*                              Apache License
    2                            Version 2.0, January 2004
    3                         http://www.apache.org/licenses/
    4 
    5    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
    6 
    7    1. Definitions.
    8 
    9       "License" shall mean the terms and conditions for use, reproduction,
    10       and distribution as defined by Sections 1 through 9 of this document.
    11 
    12       "Licensor" shall mean the copyright owner or entity authorized by
    13       the copyright owner that is granting the License.
    14 
    15       "Legal Entity" shall mean the union of the acting entity and all
    16       other entities that control, are controlled by, or are under common
    17       control with that entity. For the purposes of this definition,
    18       "control" means (i) the power, direct or indirect, to cause the
    19       direction or management of such entity, whether by contract or
    20       otherwise, or (ii) ownership of fifty percent (50%) or more of the
    21       outstanding shares, or (iii) beneficial ownership of such entity.
    22 
    23       "You" (or "Your") shall mean an individual or Legal Entity
    24       exercising permissions granted by this License.
    25 
    26       "Source" form shall mean the preferred form for making modifications,
    27       including but not limited to software source code, documentation
    28       source, and configuration files.
    29 
    30       "Object" form shall mean any form resulting from mechanical
    31       transformation or translation of a Source form, including but
    32       not limited to compiled object code, generated documentation,
    33       and conversions to other media types.
    34 
    35       "Work" shall mean the work of authorship, whether in Source or
    36       Object form, made available under the License, as indicated by a
    37       copyright notice that is included in or attached to the work
    38       (an example is provided in the Appendix below).
    39 
    40       "Derivative Works" shall mean any work, whether in Source or Object
    41       form, that is based on (or derived from) the Work and for which the
    42       editorial revisions, annotations, elaborations, or other modifications
    43       represent, as a whole, an original work of authorship. For the purposes
    44       of this License, Derivative Works shall not include works that remain
    45       separable from, or merely link (or bind by name) to the interfaces of,
    46       the Work and Derivative Works thereof.
    47 
    48       "Contribution" shall mean any work of authorship, including
    49       the original version of the Work and any modifications or additions
    50       to that Work or Derivative Works thereof, that is intentionally
    51       submitted to Licensor for inclusion in the Work by the copyright owner
    52       or by an individual or Legal Entity authorized to submit on behalf of
    53       the copyright owner. For the purposes of this definition, "submitted"
    54       means any form of electronic, verbal, or written communication sent
    55       to the Licensor or its representatives, including but not limited to
    56       communication on electronic mailing lists, source code control systems,
    57       and issue tracking systems that are managed by, or on behalf of, the
    58       Licensor for the purpose of discussing and improving the Work, but
    59       excluding communication that is conspicuously marked or otherwise
    60       designated in writing by the copyright owner as "Not a Contribution."
    61 
    62       "Contributor" shall mean Licensor and any individual or Legal Entity
    63       on behalf of whom a Contribution has been received by Licensor and
    64       subsequently incorporated within the Work.
    65 
    66    2. Grant of Copyright License. Subject to the terms and conditions of
    67       this License, each Contributor hereby grants to You a perpetual,
    68       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
    69       copyright license to reproduce, prepare Derivative Works of,
    70       publicly display, publicly perform, sublicense, and distribute the
    71       Work and such Derivative Works in Source or Object form.
    72 
    73    3. Grant of Patent License. Subject to the terms and conditions of
    74       this License, each Contributor hereby grants to You a perpetual,
    75       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
    76       (except as stated in this section) patent license to make, have made,
    77       use, offer to sell, sell, import, and otherwise transfer the Work,
    78       where such license applies only to those patent claims licensable
    79       by such Contributor that are necessarily infringed by their
    80       Contribution(s) alone or by combination of their Contribution(s)
    81       with the Work to which such Contribution(s) was submitted. If You
    82       institute patent litigation against any entity (including a
    83       cross-claim or counterclaim in a lawsuit) alleging that the Work
    84       or a Contribution incorporated within the Work constitutes direct
    85       or contributory patent infringement, then any patent licenses
    86       granted to You under this License for that Work shall terminate
    87       as of the date such litigation is filed.
    88 
    89    4. Redistribution. You may reproduce and distribute copies of the
    90       Work or Derivative Works thereof in any medium, with or without
    91       modifications, and in Source or Object form, provided that You
    92       meet the following conditions:
    93 
    94       (a) You must give any other recipients of the Work or
    95           Derivative Works a copy of this License; and
    96 
    97       (b) You must cause any modified files to carry prominent notices
    98           stating that You changed the files; and
    99 
    100       (c) You must retain, in the Source form of any Derivative Works
    101           that You distribute, all copyright, patent, trademark, and
    102           attribution notices from the Source form of the Work,
    103           excluding those notices that do not pertain to any part of
    104           the Derivative Works; and
    105 
    106       (d) If the Work includes a "NOTICE" text file as part of its
    107           distribution, then any Derivative Works that You distribute must
    108           include a readable copy of the attribution notices contained
    109           within such NOTICE file, excluding those notices that do not
    110           pertain to any part of the Derivative Works, in at least one
    111           of the following places: within a NOTICE text file distributed
    112           as part of the Derivative Works; within the Source form or
    113           documentation, if provided along with the Derivative Works; or,
    114           within a display generated by the Derivative Works, if and
    115           wherever such third-party notices normally appear. The contents
    116           of the NOTICE file are for informational purposes only and
    117           do not modify the License. You may add Your own attribution
    118           notices within Derivative Works that You distribute, alongside
    119           or as an addendum to the NOTICE text from the Work, provided
    120           that such additional attribution notices cannot be construed
    121           as modifying the License.
    122 
    123       You may add Your own copyright statement to Your modifications and
    124       may provide additional or different license terms and conditions
    125       for use, reproduction, or distribution of Your modifications, or
    126       for any such Derivative Works as a whole, provided Your use,
    127       reproduction, and distribution of the Work otherwise complies with
    128       the conditions stated in this License.
    129 
    130    5. Submission of Contributions. Unless You explicitly state otherwise,
    131       any Contribution intentionally submitted for inclusion in the Work
    132       by You to the Licensor shall be under the terms and conditions of
    133       this License, without any additional terms or conditions.
    134       Notwithstanding the above, nothing herein shall supersede or modify
    135       the terms of any separate license agreement you may have executed
    136       with Licensor regarding such Contributions.
    137 
    138    6. Trademarks. This License does not grant permission to use the trade
    139       names, trademarks, service marks, or product names of the Licensor,
    140       except as required for reasonable and customary use in describing the
    141       origin of the Work and reproducing the content of the NOTICE file.
    142 
    143    7. Disclaimer of Warranty. Unless required by applicable law or
    144       agreed to in writing, Licensor provides the Work (and each
    145       Contributor provides its Contributions) on an "AS IS" BASIS,
    146       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
    147       implied, including, without limitation, any warranties or conditions
    148       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
    149       PARTICULAR PURPOSE. You are solely responsible for determining the
    150       appropriateness of using or redistributing the Work and assume any
    151       risks associated with Your exercise of permissions under this License.
    152 
    153    8. Limitation of Liability. In no event and under no legal theory,
    154       whether in tort (including negligence), contract, or otherwise,
    155       unless required by applicable law (such as deliberate and grossly
    156       negligent acts) or agreed to in writing, shall any Contributor be
    157       liable to You for damages, including any direct, indirect, special,
    158       incidental, or consequential damages of any character arising as a
    159       result of this License or out of the use or inability to use the
    160       Work (including but not limited to damages for loss of goodwill,
    161       work stoppage, computer failure or malfunction, or any and all
    162       other commercial damages or losses), even if such Contributor
    163       has been advised of the possibility of such damages.
    164 
    165    9. Accepting Warranty or Additional Liability. While redistributing
    166       the Work or Derivative Works thereof, You may choose to offer,
    167       and charge a fee for, acceptance of support, warranty, indemnity,
    168       or other liability obligations and/or rights consistent with this
    169       License. However, in accepting such obligations, You may act only
    170       on Your own behalf and on Your sole responsibility, not on behalf
    171       of any other Contributor, and only if You agree to indemnify,
    172       defend, and hold each Contributor harmless for any liability
    173       incurred by, or claims asserted against, such Contributor by reason
    174       of your accepting any such warranty or additional liability.
    175 
    176    END OF TERMS AND CONDITIONS
    177 
    178    APPENDIX: How to apply the Apache License to your work.
    179 
    180       To apply the Apache License to your work, attach the following
    181       boilerplate notice, with the fields enclosed by brackets "[]"
    182       replaced with your own identifying information. (Don't include
    183       the brackets!)  The text should be enclosed in the appropriate
    184       comment syntax for the file format. We also recommend that a
    185       file or class name and description of purpose be included on the
    186       same "printed page" as the copyright notice for easier
    187       identification within third-party archives.
    188 
     1/*
    1892   Copyright [2008] [Thomas Schmid, University of Siegen]
    1903
     
    21730namespace FileInput
    21831{
    219   [Author("Thomas Schmid", "thomas.schmid@cryptool.org", "Uni Siegen", "http://www.uni-siegen.de")]
    220   [PluginInfo(true, "FileInput", "File based input", "", "FileInput/Images/FileInput.png")] 
    221   public class FileInputClass : IInput
    222   {
    223     #region Private variables
    224     private const int MAX_BYTE_ARRAY_SIZE = 10485760; // 20MB
    225     private FileInputPresentation fileInputPresentation;   
    226     private FileInputSettings settings;
    227     private List<CryptoolStream> listCryptoolStreamsOut = new List<CryptoolStream>();
    228     #endregion
    229 
    230     public FileInputClass()
     32    [Author("Thomas Schmid", "thomas.schmid@cryptool.org", "Uni Siegen", "http://www.uni-siegen.de")]
     33    [PluginInfo(true, "FileInput", "File based input", "", "FileInput/Images/FileInput.png")]
     34    public class FileInputClass : IInput
    23135    {
    232       settings = new FileInputSettings();
    233       settings.PropertyChanged += settings_PropertyChanged;
    234       fileInputPresentation = new FileInputPresentation(this);
    235 
    236       Presentation = fileInputPresentation;
    237       fileInputPresentation.UscHexBoc.OnExceptionOccured += UscHexBoc_OnExceptionOccured;
    238       fileInputPresentation.UscHexBoc.OnInformationOccured += UscHexBoc_OnInformationOccured;
     36        #region Private variables
     37        private const int MAX_BYTE_ARRAY_SIZE = 10485760; // 20MB
     38        private FileInputPresentation fileInputPresentation;
     39        private FileInputSettings settings;
     40        private List<CryptoolStream> listCryptoolStreamsOut = new List<CryptoolStream>();
     41        #endregion
     42
     43        public FileInputClass()
     44        {
     45            settings = new FileInputSettings();
     46            settings.PropertyChanged += settings_PropertyChanged;
     47            fileInputPresentation = new FileInputPresentation(this);
     48
     49            Presentation = fileInputPresentation;
     50            fileInputPresentation.UscHexBoc.OnExceptionOccured += UscHexBoc_OnExceptionOccured;
     51            fileInputPresentation.UscHexBoc.OnInformationOccured += UscHexBoc_OnInformationOccured;
     52        }
     53
     54        void settings_PropertyChanged(object sender, PropertyChangedEventArgs e)
     55        {
     56
     57            if (e.PropertyName == "OpenFilename")
     58            {
     59                string fileName = settings.OpenFilename;
     60
     61                if (File.Exists(fileName))
     62                {
     63                    fileInputPresentation.OpenFile(settings.OpenFilename);
     64                    FileSize = (int)new FileInfo(fileName).Length;
     65                    GuiLogMessage("Opened file: " + settings.OpenFilename + " " + FileHelper.FilesizeReadable(settings.OpenFilename), NotificationLevel.Info);
     66                }
     67                else if (e.PropertyName == "OpenFilename" && fileName == null)
     68                {
     69
     70                    fileInputPresentation.CloseFile();
     71                    FileSize = 0;
     72                }
     73                NotifyPropertyChange();
     74            }
     75        }
     76
     77        #region Properties
     78        public ISettings Settings
     79        {
     80            get { return (ISettings)settings; }
     81            set { settings = (FileInputSettings)value; }
     82        }
     83
     84        [PropertyInfo(Direction.OutputData, "Stream Output", "Selected file as stream.", "", true, false, DisplayLevel.Beginner, QuickWatchFormat.Hex, null)]
     85        public CryptoolStream StreamOutput
     86        {
     87            get
     88            {
     89                try
     90                {
     91                    Progress(0.5, 1.0);
     92                    if (File.Exists(settings.OpenFilename))
     93                    {
     94                        CryptoolStream cryptoolStream = new CryptoolStream();
     95                        cryptoolStream.OpenRead(settings.OpenFilename);
     96                        listCryptoolStreamsOut.Add(cryptoolStream);
     97
     98                        Progress(1.0, 1.0);
     99                        return cryptoolStream;
     100                    }
     101                    return null;
     102                }
     103                catch (Exception exception)
     104                {
     105                    GuiLogMessage(exception.Message, NotificationLevel.Error);
     106                    return null;
     107                }
     108            }
     109            set { } // readonly
     110        }
     111
     112        [PropertyInfo(Direction.OutputData, "File Size", "Size of the selected file", "", DisplayLevel.Beginner)]
     113        public int FileSize { get; private set; }
     114
     115        #endregion
     116
     117        void UscHexBoc_OnInformationOccured(object sender, Exception e)
     118        {
     119            GuiLogMessage(e.Message, NotificationLevel.Info);
     120        }
     121
     122        void UscHexBoc_OnExceptionOccured(object sender, Exception e)
     123        {
     124            GuiLogMessage(e.Message, NotificationLevel.Error);
     125        }
     126
     127        #region IPlugin Members
     128        public event StatusChangedEventHandler OnPluginStatusChanged;
     129        public event GuiLogNotificationEventHandler OnGuiLogNotificationOccured;
     130        public event PluginProgressChangedEventHandler OnPluginProgressChanged;
     131
     132        public UserControl Presentation { get; private set; }
     133
     134        public UserControl QuickWatchPresentation
     135        {
     136            get { return null; }
     137        }
     138
     139        public void Initialize()
     140        {
     141            fileInputPresentation.CloseFile();
     142            if (File.Exists(settings.OpenFilename))
     143            {
     144                fileInputPresentation.OpenFile(settings.OpenFilename);
     145                NotifyPropertyChange();
     146            }
     147        }
     148
     149        /// <summary>
     150        /// Close open file and save open filename to settings. Will be called when saving
     151        /// workspace or when deleting an element instance from workspace.
     152        /// </summary>
     153        public void Dispose()
     154        {
     155            foreach (CryptoolStream stream in listCryptoolStreamsOut)
     156                stream.Close();
     157
     158            listCryptoolStreamsOut.Clear();
     159            fileInputPresentation.CloseFileToGetFileStreamForExecution();
     160        }
     161
     162        public void Stop()
     163        {
     164
     165        }
     166
     167        public void PreExecution()
     168        {
     169            DispatcherHelper.ExecuteMethod(fileInputPresentation.Dispatcher,
     170              fileInputPresentation, "CloseFileToGetFileStreamForExecution", null);
     171            Dispose();
     172        }
     173
     174        public void PostExecution()
     175        {
     176            Dispose();
     177            DispatcherHelper.ExecuteMethod(fileInputPresentation.Dispatcher,
     178              fileInputPresentation, "ReopenClosedFile", null);
     179        }
     180
     181        #endregion
     182
     183        #region INotifyPropertyChanged Members
     184
     185        public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;
     186
     187        public void OnPropertyChanged(string name)
     188        {
     189            EventsHelper.PropertyChanged(PropertyChanged, this, new PropertyChangedEventArgs(name));
     190        }
     191
     192        #endregion
     193
     194        #region methods
     195        public void NotifyPropertyChange()
     196        {
     197            OnPropertyChanged("StreamOutput");
     198            OnPropertyChanged("FileSize");
     199        }
     200
     201        private void Progress(double value, double max)
     202        {
     203            EventsHelper.ProgressChanged(OnPluginProgressChanged, this, new PluginProgressEventArgs(value, max));
     204        }
     205
     206        private void GuiLogMessage(string message, NotificationLevel logLevel)
     207        {
     208            EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(message, this, logLevel));
     209        }
     210        #endregion
     211
     212        #region IPlugin Members
     213
     214
     215        public void Execute()
     216        {
     217            NotifyPropertyChange();
     218        }
     219
     220        public void Pause()
     221        {
     222        }
     223
     224        #endregion
    239225    }
    240 
    241     void settings_PropertyChanged(object sender, PropertyChangedEventArgs e)
    242     {
    243       if (e.PropertyName == "OpenFilename" && File.Exists(settings.OpenFilename))
    244       {
    245         fileInputPresentation.OpenFile(settings.OpenFilename);
    246         GuiLogMessage("Opened file: " + settings.OpenFilename + " " + FileHelper.FilesizeReadable(settings.OpenFilename), NotificationLevel.Info);
    247       }
    248       else if (e.PropertyName == "OpenFilename" && settings.OpenFilename == null)
    249       {
    250         fileInputPresentation.CloseFile();
    251       }
    252       NotifyPropertyChange();
    253     }
    254 
    255     # region Properties
    256     public ISettings Settings
    257     {
    258       get { return (ISettings)settings; }
    259       set { settings = (FileInputSettings)value; }
    260     }
    261 
    262     [PropertyInfo(Direction.OutputData, "Stream Output", "Selected file as stream.", "", true, false, DisplayLevel.Beginner, QuickWatchFormat.Hex, null)]
    263     public CryptoolStream StreamOutput
    264     {
    265       get
    266       {
    267         try
    268         {
    269           Progress(0.5, 1.0);
    270           if (File.Exists(settings.OpenFilename))
    271           {           
    272             CryptoolStream cryptoolStream = new CryptoolStream();
    273             cryptoolStream.OpenRead(settings.OpenFilename);
    274             listCryptoolStreamsOut.Add(cryptoolStream);
    275 
    276             Progress(1.0, 1.0);
    277             return cryptoolStream;
    278           }
    279           return null;
    280         }
    281         catch (Exception exception)
    282         {
    283           GuiLogMessage(exception.Message, NotificationLevel.Error);
    284           return null;
    285         }
    286       }
    287       set { } // readonly
    288     }
    289 
    290     #endregion
    291 
    292     void UscHexBoc_OnInformationOccured(object sender, Exception e)
    293     {
    294       GuiLogMessage(e.Message, NotificationLevel.Info);
    295     }
    296 
    297     void UscHexBoc_OnExceptionOccured(object sender, Exception e)
    298     {
    299       GuiLogMessage(e.Message, NotificationLevel.Error);     
    300     }
    301 
    302     #region IPlugin Members
    303     public event StatusChangedEventHandler OnPluginStatusChanged;
    304     public event GuiLogNotificationEventHandler OnGuiLogNotificationOccured;
    305     public event PluginProgressChangedEventHandler OnPluginProgressChanged;
    306 
    307     public UserControl Presentation { get; private set; }
    308 
    309     public UserControl QuickWatchPresentation
    310     {
    311       get { return null; }
    312     }
    313 
    314     public void Initialize()
    315     {
    316       fileInputPresentation.CloseFile();
    317       if (File.Exists(settings.OpenFilename))
    318       {
    319         fileInputPresentation.OpenFile(settings.OpenFilename);
    320         NotifyPropertyChange();
    321       }
    322     }
    323 
    324     /// <summary>
    325     /// Close open file and save open filename to settings. Will be called when saving
    326     /// workspace or when deleting an element instance from workspace.
    327     /// </summary>
    328     public void Dispose()
    329     {
    330       foreach (CryptoolStream stream in listCryptoolStreamsOut)
    331         stream.Close();
    332 
    333       listCryptoolStreamsOut.Clear();
    334       fileInputPresentation.CloseFileToGetFileStreamForExecution();     
    335     }
    336 
    337     public void Stop()
    338     {
    339 
    340     }
    341 
    342     public void PreExecution()
    343     {
    344       DispatcherHelper.ExecuteMethod(fileInputPresentation.Dispatcher,
    345         fileInputPresentation, "CloseFileToGetFileStreamForExecution", null);
    346       Dispose();
    347     }
    348 
    349     public void PostExecution()
    350     {
    351       Dispose();
    352       DispatcherHelper.ExecuteMethod(fileInputPresentation.Dispatcher,
    353         fileInputPresentation, "ReopenClosedFile", null);
    354     }
    355 
    356     #endregion
    357 
    358     #region INotifyPropertyChanged Members
    359 
    360     public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;
    361 
    362     public void OnPropertyChanged(string name)
    363     {
    364       EventsHelper.PropertyChanged(PropertyChanged, this, new PropertyChangedEventArgs(name));
    365     }
    366 
    367     #endregion
    368 
    369     #region methods
    370     public void NotifyPropertyChange()
    371     {
    372       OnPropertyChanged("StreamOutput");
    373     }
    374 
    375     private void Progress(double value, double max)
    376     {
    377       EventsHelper.ProgressChanged(OnPluginProgressChanged, this, new PluginProgressEventArgs(value, max));
    378     }
    379 
    380     private void GuiLogMessage(string message, NotificationLevel logLevel)
    381     {
    382       EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(message, this, logLevel));
    383     }
    384     #endregion
    385 
    386     #region IPlugin Members
    387 
    388 
    389     public void Execute()
    390     {
    391       NotifyPropertyChange();
    392     }
    393 
    394     public void Pause()
    395     {
    396     }
    397 
    398     #endregion
    399   }
    400226}
Note: See TracChangeset for help on using the changeset viewer.