1 //
2 // Package.cs
3 //
4 // Author:
5 //   Lluis Sanchez Gual
6 //
7 // Copyright (C) 2007 Novell, Inc (http://www.novell.com)
8 //
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
16 //
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 //
28 
29 using System;
30 using System.IO;
31 using Mono.Addins.Description;
32 
33 namespace Mono.Addins.Setup
34 {
35 	/// <summary>
36 	/// An add-in package
37 	/// </summary>
38 	public abstract class Package
39 	{
Package()40 		internal Package ()
41 		{
42 		}
43 
44 		/// <summary>
45 		/// Name of the package
46 		/// </summary>
47 		public abstract string Name { get; }
48 
49 		/// <summary>
50 		/// Returns true if the package will be installed in the shared directory,
51 		/// false if it will be installed in the user directory.
52 		/// </summary>
53 		public virtual bool SharedInstall {
54 			get { return false; }
55 		}
56 
57 		/// <summary>
58 		/// Creates a package object for an add-in available in an on-line repository
59 		/// </summary>
60 		/// <param name="repAddin">
61 		/// An add-in reference
62 		/// </param>
63 		/// <returns>
64 		/// The package
65 		/// </returns>
FromRepository(AddinRepositoryEntry repAddin)66 		public static Package FromRepository (AddinRepositoryEntry repAddin)
67 		{
68 			return AddinPackage.PackageFromRepository (repAddin);
69 		}
70 
71 		/// <summary>
72 		/// Creates a package object for a local package file
73 		/// </summary>
74 		/// <param name="file">
75 		/// Package file path
76 		/// </param>
77 		/// <returns>
78 		/// The package
79 		/// </returns>
FromFile(string file)80 		public static Package FromFile (string file)
81 		{
82 			return AddinPackage.PackageFromFile (file);
83 		}
84 
85 
Resolve(IProgressMonitor monitor, AddinStore service, PackageCollection toInstall, PackageCollection toUninstall, PackageCollection required, DependencyCollection unresolved)86 		internal abstract void Resolve (IProgressMonitor monitor, AddinStore service, PackageCollection toInstall, PackageCollection toUninstall, PackageCollection required, DependencyCollection unresolved);
87 
PrepareInstall(IProgressMonitor monitor, AddinStore service)88 		internal abstract void PrepareInstall (IProgressMonitor monitor, AddinStore service);
CommitInstall(IProgressMonitor monitor, AddinStore service)89 		internal abstract void CommitInstall (IProgressMonitor monitor, AddinStore service);
RollbackInstall(IProgressMonitor monitor, AddinStore service)90 		internal abstract void RollbackInstall (IProgressMonitor monitor, AddinStore service);
91 
PrepareUninstall(IProgressMonitor monitor, AddinStore service)92 		internal abstract void PrepareUninstall (IProgressMonitor monitor, AddinStore service);
CommitUninstall(IProgressMonitor monitor, AddinStore service)93 		internal abstract void CommitUninstall (IProgressMonitor monitor, AddinStore service);
RollbackUninstall(IProgressMonitor monitor, AddinStore service)94 		internal abstract void RollbackUninstall (IProgressMonitor monitor, AddinStore service);
95 
IsUpgradeOf(Package p)96 		internal abstract bool IsUpgradeOf (Package p);
97 
EndInstall(IProgressMonitor monitor, AddinStore service)98 		internal virtual void EndInstall (IProgressMonitor monitor, AddinStore service)
99 		{
100 		}
101 
EndUninstall(IProgressMonitor monitor, AddinStore service)102 		internal virtual void EndUninstall (IProgressMonitor monitor, AddinStore service)
103 		{
104 		}
105 
CreateTempFolder()106 		internal string CreateTempFolder ()
107 		{
108 			string bname = Path.Combine (Path.GetTempPath (), "mdtmp");
109 			string tempFolder = bname;
110 			int n = 0;
111 			while (Directory.Exists (tempFolder))
112 				tempFolder = bname + (++n);
113 			return tempFolder;
114 		}
115 	}
116 }
117