source: trunk/CrypPlugins/Dictionary/Dictionary.cs @ 1188

Last change on this file since 1188 was 1188, checked in by Matthäus Wander, 12 years ago

CrypWin & Editor are heavily leaking memory... added clumsy hacks to work around

File size: 20.2 KB
Line 
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
189   Copyright [2008] [Thomas Schmid, University of Siegen]
190
191   Licensed under the Apache License, Version 2.0 (the "License");
192   you may not use this file except in compliance with the License.
193   You may obtain a copy of the License at
194
195       http://www.apache.org/licenses/LICENSE-2.0
196
197   Unless required by applicable law or agreed to in writing, software
198   distributed under the License is distributed on an "AS IS" BASIS,
199   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200   See the License for the specific language governing permissions and
201   limitations under the License.
202*/
203
204using System;
205using System.Collections.Generic;
206using System.Linq;
207using System.Text;
208using Cryptool.PluginBase.IO;
209using Cryptool.PluginBase;
210using System.Windows.Controls;
211using System.ComponentModel;
212using System.Runtime.CompilerServices;
213using System.Collections;
214using System.IO;
215using Cryptool.PluginBase.Miscellaneous;
216using System.Diagnostics;
217using System.Collections.ObjectModel;
218
219namespace Dictionary
220{
221    [Author("Thomas Schmid, Matthäus Wander", "thomas.schmid@cryptool.org", "Uni Siegen", "http://www.uni-siegen.de")]
222    [PluginInfo(true, "Dictionary", "Reads values from a Dictionary and returns all entries concatenated with given delimiter in one string.", null, "Dictionary/icon.png")]
223    public class CryptoolDictionary : IInput
224    {
225        # region private_variables
226
227        private const string DATATYPE = "wordlists";
228
229        private CryptoolDictionarySettings settings = new CryptoolDictionarySettings();
230
231        // dictionary name -> collection of words
232        private static Dictionary<DataFileMetaInfo, string[]> dicValues = new Dictionary<DataFileMetaInfo, string[]>();
233        private static Dictionary<DataFileMetaInfo, string> dicValuesOld = new Dictionary<DataFileMetaInfo, string>();
234       
235        // list of dictionaries
236        private static DataFileMetaInfo[] dicList;
237
238        // Manages wordlist files
239        private DataManager dataMgr = new DataManager();
240
241        // Flag to enable re-execution during play mode
242        private bool allowReexecution = false;
243
244        # endregion private_variables
245
246        public DataFileMetaInfo CurrentDicSelection
247        {
248            get
249            {
250                if (dicList != null && settings.Dictionary >= 0 && settings.Dictionary < dicList.Length)
251                    return dicList[settings.Dictionary];
252                else
253                    return null;
254            }
255        }
256
257        public CryptoolDictionary()
258        {
259        }
260
261        [Obsolete("Use string[] output instead")]
262        [PropertyInfo(Direction.OutputData, "Dictionary output (deprecated)", "Values from dictionary as single string (deprecated)", "", false, false, DisplayLevel.Beginner, QuickWatchFormat.Text, null)]
263        public string OutputString
264        {
265            get
266            {
267                if (OutputList != null)
268                {
269                    Debug.Assert(CurrentDicSelection != null);
270                    if (!dicValuesOld.ContainsKey(CurrentDicSelection))
271                        dicValuesOld.Add(CurrentDicSelection, string.Join(" ", OutputList));
272
273                    return dicValuesOld[CurrentDicSelection];
274                }
275
276                return null;
277            }
278            set { } // readonly
279        }
280
281        [PropertyInfo(Direction.OutputData, "Dictionary Output", "Values from dictionary as array of strings", "", false, false, DisplayLevel.Beginner, QuickWatchFormat.Text, null)]
282        public string[] OutputList
283        {
284            get
285            {
286                if (CurrentDicSelection != null)
287                {
288                    if (dicValues.ContainsKey(CurrentDicSelection) || LoadDictionary(CurrentDicSelection))
289                        return dicValues[CurrentDicSelection];
290                }
291
292                return null;
293            }
294            set { } // readonly
295        }
296
297        #region IPlugin Members
298
299#pragma warning disable 67
300        public event StatusChangedEventHandler OnPluginStatusChanged;
301#pragma warning restore
302
303        public event GuiLogNotificationEventHandler OnGuiLogNotificationOccured;
304
305        public event PluginProgressChangedEventHandler OnPluginProgressChanged;
306
307        private void GuiLogMessage(string message, NotificationLevel logLevel)
308        {
309            EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(message, this, logLevel));
310        }
311
312        public ISettings Settings
313        {
314            get { return settings; }
315        }
316
317        public UserControl Presentation
318        {
319            get { return null; }
320        }
321
322        public UserControl QuickWatchPresentation
323        {
324            get { return null; }
325        }
326
327        public void PreExecution()
328        {
329        }
330
331        public void Execute()
332        {
333            if (CurrentDicSelection == null)
334            {
335                GuiLogMessage("No dictionary chosen.", NotificationLevel.Error);
336                return;
337            }
338
339            EventsHelper.ProgressChanged(OnPluginProgressChanged, this, new PluginProgressEventArgs(50, 100));
340            EventsHelper.PropertyChanged(PropertyChanged, this, new PropertyChangedEventArgs("OutputList"));
341            EventsHelper.PropertyChanged(PropertyChanged, this, new PropertyChangedEventArgs("OutputString"));
342            EventsHelper.ProgressChanged(OnPluginProgressChanged, this, new PluginProgressEventArgs(100, 100));
343
344            // enable re-execution after the first run
345            allowReexecution = true;
346        }
347
348        public void PostExecution()
349        {
350            // disable re-execution when leaving play mode
351            allowReexecution = false;
352        }
353
354        public void Pause()
355        {
356        }
357
358        public void Stop()
359        {
360        }
361
362        /// <summary>
363        /// Loads dictionary file based on current setting.
364        /// </summary>
365        /// <returns>true if file has been loaded correctly</returns>
366        [MethodImpl(MethodImplOptions.Synchronized)]
367        private bool LoadDictionary(DataFileMetaInfo file)
368        {
369            // sanity check for multi-threading
370            if (dicValues.ContainsKey(file))
371                return true;
372
373            try
374            {
375                if (file.DataFile.Exists)
376                {
377                    EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(string.Format(Properties.Resources.loading_dic_now, new object[] { file.Name }), this, NotificationLevel.Info));
378                    Stopwatch stopWatch = new Stopwatch();
379                    stopWatch.Start();
380
381                    FileStream fs = file.DataFile.OpenRead();
382                    StreamReader sr;
383                    if (file.TextEncoding == null)
384                        sr = new StreamReader(fs);
385                    else
386                        sr = new StreamReader(fs, file.TextEncoding);
387
388                    List<string> list = new List<string>();
389                    while (!sr.EndOfStream)
390                    {
391                        list.Add(sr.ReadLine());
392                    }
393                    dicValues.Add(file, list.ToArray());
394
395                    stopWatch.Stop();
396                    // This log msg is shown on init after first using this plugin, even if event subscription
397                    // should not have been done yet. Results from using static LoadContent method.
398                    EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(string.Format(Properties.Resources.finished_loading_dic, new object[] { stopWatch.Elapsed.Milliseconds }), this, NotificationLevel.Info));
399
400                    return true;
401                }
402                else
403                {
404                    EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(string.Format(Properties.Resources.dic_file_not_found, new object[] { file.ToString() }), this, NotificationLevel.Error));
405                }
406            }
407            catch (Exception exception)
408            {
409                EventsHelper.GuiLogMessage(OnGuiLogNotificationOccured, this, new GuiLogEventArgs(exception.Message, this, NotificationLevel.Error));
410            }
411
412            return false;
413        }
414
415        public void Initialize()
416        {
417            LoadFileList();
418
419            settings.PropertyChanged += SettingsPropertyChanged; // catch settings changes
420        }
421
422        private void SettingsPropertyChanged(object sender, PropertyChangedEventArgs e)
423        {
424            // if user chooses another dictionary, force re-execution
425            if (allowReexecution && e.PropertyName == "Dictionary")
426            {
427                Execute();
428            }
429        }
430
431        [MethodImpl(MethodImplOptions.Synchronized)]
432        private void LoadFileList()
433        {
434            dicList = dataMgr.LoadDirectory(DATATYPE).Values.ToArray();
435
436            if (settings.Collection.Count > 0)
437                settings.Collection.Clear();
438
439            foreach (DataFileMetaInfo meta in dicList)
440            {
441                settings.Collection.Add(meta.Name);
442            }
443        }
444
445        public void Dispose()
446        {
447            dicValues.Clear();
448            dicValuesOld.Clear();
449        }
450
451        #endregion
452
453        #region INotifyPropertyChanged Members
454
455        public event PropertyChangedEventHandler PropertyChanged;
456
457        #endregion
458    }
459}
Note: See TracBrowser for help on using the repository browser.