Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 344653

Summary: [EditorMgmt] Editors should be able to treat large files specially (e.g. deny opening huge files)
Product: [Eclipse Project] Platform Reporter: Prakash Rangaraj <prakash>
Component: UIAssignee: Prakash Rangaraj <prakash>
Status: RESOLVED WONTFIX QA Contact:
Severity: enhancement    
Priority: P3 CC: bokowski, daniel_megert, duongn, eclipse, elias, jamesblackburn+eclipse, markus.kell.r, mober.at+eclipse, ob1.eclipse, prakash, pwebster, remy.suen, sptaszkiewicz, wagnross
Version: 3.6.2Flags: prakash: review?
Target Milestone: 3.6.2+   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Bug Depends on: 117746, 344031, 344652    
Bug Blocks: 344654    
Attachments:
Description Flags
Patch v01 none

Description Prakash Rangaraj CLA 2011-05-04 00:33:26 EDT 
+++ This bug was initially created as a clone of Bug #344652 +++

+++ This bug was initially created as a clone of Bug #344031 +++

+++ This bug was initially created as a clone of Bug #117746 +++

Loading large files in an editor needs a lot of memory (up to 5 times the file size, see Bugzilla 75086), so the Workbench can run into an OutOfMemory error or freeze for some time while an editor is busy loading a file.

Since users do not see in the Resource navigator how large a file is, it can easily happen that one tries to open a very large file by accident. We have auto-generated log files which range from 1 to 400 MB in size. The smaller ones we want to open in Eclipse Workbench, the larger ones we open in an external editor. Trying to opening a 400MB file in the Workbench by accident leads to an OutOfMemoryError and destabilizes the workbench or even makes it unusable for some time.

It should be possible to define a maximum file size (in the Preferences, in plugin.xml or by computing available heap size) up to which an editor editor can open a file directly. If the user tries to open a file that exceeds the given size, the user should be shown a dialog which allows to
  * Open the file in spite of the warning
  * Open the file in an alternative (external) editor instead
  * Cancel the edit request

Perhaps the best solution would be to extend the Editor API such that an editor is given the file path to be opened BEFORE it is actually opened. Thereby, each editor implementor could have policies for allowing or denying the open request.
Policies for denying could be based on file size, virtual vs. real file system [See Bugzilla 106176], file content...) In case an edit request is denied, the Platform could show a dialog like

  "Editor FooBar has denied opening 'yourFile.xxx' with the following message:
   (Custom Message e.g. File is 50MB large)
   Do you want to
     * Open the file in (Dropdown of registered editors for xxx files) instead
     * Open the file in spite of the warning
     * Cancel
  "
Comment 1 Prakash Rangaraj CLA 2011-05-04 04:46:49 EDT 
Created attachment 194677 [details]
Patch v01

Patch v01 for R3_6_maintenance branch
Comment 2 Ross Wagner CLA 2011-05-11 11:48:34 EDT 
Patch installs fine.  I'll upload it to our site soon.

Duong, can you check this for legal?

Thanks
Comment 3 Markus Keller CLA 2011-05-11 12:25:08 EDT 
(In reply to comment #1)
> Created attachment 194677 [details] [diff]
> Patch v01
> 
> Patch v01 for R3_6_maintenance branch

Note that this is not the final patch that will be released. The additional fix from bug 344031 comment 20 will also be released to the branches.
Comment 4 Dani Megert CLA 2011-06-06 09:22:13 EDT 
Prakash, can you please finish this, so that we have the right fix in all streams? Thanks.
Comment 5 Dani Megert CLA 2013-06-05 09:18:35 EDT 
Comment on attachment 194677 [details]
Patch v01

This patch is obsolete.

The change from 3.7:
http://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?h=R3_7_maintenance&id=dc09e4cc9c5dea3bfb116664884242ed1b4da9d1
should simply be applied to 4.x.
Comment 6 Martin Oberhuber CLA 2014-08-27 04:29:55 EDT 
Ping, what is the status of this ?
Comment 7 Dani Megert CLA 2014-08-27 06:17:39 EDT 
Nothing will be done for 3.6.2+ at this point. For 4.x see bug 117746.