Update-Installer/TODO

General Updater Tasks:

 * Elevation for Linux [done]
 * Set file permissions for Unix [done]
 * Elevation for Mac [done]
 * Basic functionality for Mac [done]
 * Unit test working under Mac [done]
 * Set file permissions for Windows [skipped for now]
 * Basic functionality for Windows [done]
 * Elevation for Windows [done]
 * Win32 UI for Windows [done]
 * Cocoa UI for Mac [done]
 * Gtk or Qt UI for Linux [done - GTK UI]
 * Unit test working under Windows [done]
 * Start new application once installation is finished [done]
 * Use message box for errors [done]
 * Newly installed binary needs to be launched un-elevated [done]
 * See if it is possible to overwrite application files that are in use on Windows [done - it is possible]
 * Fix package dir cleanup failing on Win32 due to executable being in use [done]
 
 * Test installing update if Microsoft Word with Mendeley plugin is active
 * Write log file entries to an actual log file [Linux, Windows: done, Mac: TODO]
 * Test updater on an old Windows system without Visual Studio installed and statically
   link C++ runtime libraries if necessary
   
Mendeley-specific Updater Tasks:
 * Use the Mendeley icon for the window on Windows [done]
 * Use the Mendeley icon for the binary on Windows [done]
 * Use the Mendeley icon for the window on Mac (N/A? - No icon in window decorations on Mac) 
 * Use the Mendeley icon for the window on Linux

 * Advise the user to download Mendeley Desktop afresh from http://www.mendeley.com/download-mendeley-desktop
   in the event of an updater problem
 * Exclude Uninstall.exe from updates on Windows - see comments in utilities/autoupdate-setup/main.cpp in
   the desktop source tree.

 * Updater binary needs to be signed under Windows

Mendeley Desktop <= 1.0 auto-update system compatibility:

 * Support for MD <= 1.0 updater command-line syntax [done]
 * Backwards compatible structure for XML file [done]

Auto-update preparation tools:

 * Tool to create .zip packages for a release and
   upload them to S3 [done]
 * Tool to generate backwards-compatible structure for XML file [done]
 * Tool to generate new structure for XML file [done]

Nice To Have
============

Update size:
 * Support for applying binary patches (eg. with bspatch/bsdiff)

Telemetry:
 * Call a project-specific URL to report successful/failed update installation
   and starting of new app after update

Source:
 * Ensure no Mendeley branding in standalone project and publish code

Reliability:
 * Create a lock to prevent Mendeley being started whilst updates are
   in progress and to prevent multiple updates being run at once.
 * Consider using file system transactions on Windows to make update installation atomic
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00			`General Updater Tasks:`
Add TODO file listing remaining tasks to do before the standalone updater can be used to replace the existing system. 2011-08-21 22:54:34 +00:00
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00			`* Elevation for Linux [done]`
Add support for the old-format updater command-line syntax. The old syntax uses a series of Key=Value pairs, instead of the more standard "--key value" syntax. This is required so that the old Mendeley Desktop versions can launch the new updater. 2011-08-22 11:59:08 +00:00			`* Set file permissions for Unix [done]`
Update the TODO file after Mac testing and make a note that elevation on Mac only works when running the app directly on the Mac (as opposed to over an SSH session). 2011-08-22 13:55:31 +00:00			`* Elevation for Mac [done]`
			`* Basic functionality for Mac [done]`
			`* Unit test working under Mac [done]`
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00			`* Set file permissions for Windows [skipped for now]`
			`* Basic functionality for Windows [done]`
			`* Elevation for Windows [done]`
			`* Win32 UI for Windows [done]`
			`* Cocoa UI for Mac [done]`
			`* Gtk or Qt UI for Linux [done - GTK UI]`
			`* Unit test working under Windows [done]`
			`* Start new application once installation is finished [done]`
Update TODO file 2011-08-24 11:17:08 +00:00			`* Use message box for errors [done]`
Fix updater cleanup of temporary directory on Windows * On Windows FileOps::removeFile() fails for updater.exe since that file is in use by the current process. Whilst it is not possible to remove the file whilst it is in use, it can be moved or scheduled for deletion on reboot. This commit changes FilesOps::removeFile() to simulate the behavior of unlink() on Linux by moving in-use files to a temporary directory and then scheduling for them to be removed on restart. 2011-08-26 11:55:09 +00:00			`* Newly installed binary needs to be launched un-elevated [done]`
			`* See if it is possible to overwrite application files that are in use on Windows [done - it is possible]`
Update the TODO file The ability to prompt the user to Retry/Cancel file writes during installation is less necessary now that we can move files that are in use. Without retry/cancel support the update installation will just be canceled if it fails. 2011-08-26 13:22:12 +00:00			`* Fix package dir cleanup failing on Win32 due to executable being in use [done]`
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00
Update the TODO file The ability to prompt the user to Retry/Cancel file writes during installation is less necessary now that we can move files that are in use. Without retry/cancel support the update installation will just be canceled if it fails. 2011-08-26 13:22:12 +00:00			`* Test installing update if Microsoft Word with Mendeley plugin is active`
Update TODO file. Add a note in the TODO file about binary patches. 2011-08-30 10:06:33 +00:00			`* Write log file entries to an actual log file [Linux, Windows: done, Mac: TODO]`
Update TODO file 2011-08-24 11:29:43 +00:00			`* Test updater on an old Windows system without Visual Studio installed and statically`
			`link C++ runtime libraries if necessary`
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00
			`Mendeley-specific Updater Tasks:`
Update TODO file 2011-08-24 15:53:18 +00:00			`* Use the Mendeley icon for the window on Windows [done]`
			`* Use the Mendeley icon for the binary on Windows [done]`
Update TODO file 2011-08-24 11:29:43 +00:00			`* Use the Mendeley icon for the window on Mac (N/A? - No icon in window decorations on Mac)`
Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00			`* Use the Mendeley icon for the window on Linux`
Add TODO file listing remaining tasks to do before the standalone updater can be used to replace the existing system. 2011-08-21 22:54:34 +00:00
Update TODO file 2011-08-24 11:29:43 +00:00			`* Advise the user to download Mendeley Desktop afresh from http://www.mendeley.com/download-mendeley-desktop`
			`in the event of an updater problem`
Update the TODO file with new tasks 2011-08-26 10:16:26 +00:00			`* Exclude Uninstall.exe from updates on Windows - see comments in utilities/autoupdate-setup/main.cpp in`
			`the desktop source tree.`
Update TODO file 2011-08-24 11:29:43 +00:00
Update TODO file 2011-08-29 20:45:02 +00:00			`* Updater binary needs to be signed under Windows`

Add TODO file listing remaining tasks to do before the standalone updater can be used to replace the existing system. 2011-08-21 22:54:34 +00:00			`Mendeley Desktop <= 1.0 auto-update system compatibility:`

Add support for the old-format updater command-line syntax. The old syntax uses a series of Key=Value pairs, instead of the more standard "--key value" syntax. This is required so that the old Mendeley Desktop versions can launch the new updater. 2011-08-22 11:59:08 +00:00			`* Support for MD <= 1.0 updater command-line syntax [done]`
			`* Backwards compatible structure for XML file [done]`
Add TODO file listing remaining tasks to do before the standalone updater can be used to replace the existing system. 2011-08-21 22:54:34 +00:00
			`Auto-update preparation tools:`

			`* Tool to create .zip packages for a release and`
Update TODO file 2011-08-29 17:49:26 +00:00			`upload them to S3 [done]`
			`* Tool to generate backwards-compatible structure for XML file [done]`
			`* Tool to generate new structure for XML file [done]`
Add TODO file listing remaining tasks to do before the standalone updater can be used to replace the existing system. 2011-08-21 22:54:34 +00:00
Update TODO file 2011-08-24 11:29:43 +00:00			`Nice To Have`
			`============`

Update TODO file. Add a note in the TODO file about binary patches. 2011-08-30 10:06:33 +00:00			`Update size:`
			`* Support for applying binary patches (eg. with bspatch/bsdiff)`

Update TODO file 2011-08-24 11:29:43 +00:00			`Telemetry:`
			`* Call a project-specific URL to report successful/failed update installation`
			`and starting of new app after update`

Update the TODO file with finished tasks and new tasks 2011-08-23 19:26:41 +00:00			`Source:`
Update TODO file 2011-08-24 11:17:08 +00:00			`* Ensure no Mendeley branding in standalone project and publish code`
Add a note about possibly using the transactional features of NTFS in Windows >= Vista for more robust update installation in future. 2011-08-26 12:15:06 +00:00
			`Reliability:`
Add a note in the TODO file about preventing multiple simultaneous updates 2011-08-30 10:03:49 +00:00			`* Create a lock to prevent Mendeley being started whilst updates are`
			`in progress and to prevent multiple updates being run at once.`
Update the TODO file The ability to prompt the user to Retry/Cancel file writes during installation is less necessary now that we can move files that are in use. Without retry/cancel support the update installation will just be canceled if it fails. 2011-08-26 13:22:12 +00:00			`* Consider using file system transactions on Windows to make update installation atomic`