File: FilterPackage.cs

package info (click to toggle)
beagle 0.2.12-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 12,204 kB
  • ctags: 16,188
  • sloc: cs: 91,628; sh: 27,627; ansic: 10,646; makefile: 2,248; xml: 15
file content (125 lines) | stat: -rw-r--r-- 4,260 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
//
// FilterPackage.cs
//
// Copyright (C) 2006 Debajyoti Bera <dbera.web@gmail.com>
//

//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

using System;

using Beagle.Util;

namespace Beagle.Filters {

	public abstract class FilterPackage : Beagle.Daemon.Filter {

		public FilterPackage ()
		{
			SnippetMode = true;
		}

		protected virtual void PullPackageProperties () { }

		private string package_name, package_version, category;
		private string homepage, summary, packager_name, packager_email, size;

		/* Some of the metadata common in all packages.
		 * Use them to display general package information in beagle frontends.
		 *  - PackageName - name of the package
		 *  - PackageVersion - package version
		 *  - Summary - short description of the package (if available)
		 *  - Category - category of the package (if available)
		 *  - Homepage - Homepage URL of the package/project (if available)
		 *  - Packager - Packager information of the package (if available)
		 *  - Size - Size of the package (in bytes)
		 */

		// Name of the package
		protected string PackageName  {
			get { return package_name; }
			set { package_name = value; }
		}

		// Version
		protected string PackageVersion {
			get { return package_version; }
			set { package_version = value; }
		}

		// A short summary. Some packages might not have this.
		// The longer description stored as AppendText. When you request snippet, it is fetched from the description.
		// It is not possible to retrieve the whole of description from frontends. Use summary for a short description.
		protected string Summary {
			get { return summary; }
			set { summary = value; }
		}

		// Category/section to which the package might belong. Not all packages might have this.
		protected string Category {
			get { return category; }
			set { category = value; }
		}

		// Homepage of the package
		protected string Homepage {
			get { return homepage; }
			set { homepage = value; }
		}

		// Packager.
		// Use either the homepage or packager to provide a external link for more information
		// Not all packages have both set; however most have at least one
		protected string PackagerName {
			get { return packager_name; }
			set { packager_name = value; }
		}

		protected string PackagerEmail {
			get { return packager_email; }
			set { packager_email = value; }
		}

		// Size of the package - in bytes.
		// Depending on package, its either the installed size or the size of the package.
		protected string Size {
			get { return size; }
			set { size = value; }
		}

		protected override void DoPullProperties ()
		{
			PullPackageProperties ();

			AddProperty (Beagle.Property.New ("dc:title", package_name));
			AddProperty (Beagle.Property.NewKeyword ("fixme:version", package_version));
			AddProperty (Beagle.Property.New ("dc:subject", summary));
			AddProperty (Beagle.Property.New ("fixme:category", category));
			AddProperty (Beagle.Property.NewUnsearched ("dc:source", homepage));
			AddProperty (Beagle.Property.New ("fixme:packager_name", packager_name));
			AddProperty (Beagle.Property.New ("fixme:packager_email", packager_email));
			AddProperty (Beagle.Property.NewUnsearched ("fixme:size", size));

			Finished ();
		}

	}
}