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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/******************************************************************************
* The MIT/X11/Expat License
* Copyright (c) 2010 Manish Sinha<mail@manishsinha.net>
* 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 System.Collections.Generic;
using Zeitgeist.Client;
using DBus;
using Zeitgeist.Datamodel;
namespace Zeitgeist
{
/// <summary>
/// The Zeitgeist engine maintains a publicly available list of recognized data-sources
/// (components inserting information into Zeitgeist). An option to disable such data-providers is also provided.
/// </summary>
public class DataSourceClient
{
/// <summary>
/// The constructor for DataSourceClient
/// </summary>
/// <remarks>
/// This constructor gets the DBus object for DataSource which the object's methods use.
/// Additionally it chains the events from IDataSource to DataSourceClient
/// </remarks>
public DataSourceClient()
{
srcInterface = ZsUtils.GetDBusObject<IDataSource>(objectPath);
// Data Source Registered
srcInterface.DataSourceRegistered += delegate(DataSource datasource) {
if(this.DataSourceRegistered != null)
{
this.DataSourceRegistered(datasource);
}
};
// Data Source Enabled
srcInterface.DataSourceEnabled += delegate(string dataSourceValue, bool enabled) {
if(this.DataSourceEnabled != null)
{
this.DataSourceEnabled(dataSourceValue, enabled);
}
};
// Data Source Disconnected
srcInterface.DataSourceDisconnected += delegate(DataSource datasource) {
if(this.DataSourceDisconnected != null)
{
this.DataSourceDisconnected(datasource);
}
};
}
/// <summary>
/// Get the list of known data-sources.
/// </summary>
/// <returns>
/// A list of DataSource of type <see cref="T:System.Collection.Generic.List{Zeitgeist.Datamodel.Event}"/>
/// </returns>
public List<DataSource> GetDataSources()
{
RawDataSource[] srcs = srcInterface.GetDataSources();
List<DataSource> srcList = new List<DataSource>();
foreach(RawDataSource src in srcs)
{
DataSource et = RawDataSource.FromRaw(src);
srcList.Add(et);
}
return srcList;
}
/// <summary>
/// Register a data-source as currently running.
/// If the data-source was already in the database, its metadata (name, description and event_templates) are updated.
/// </summary>
/// <param name="uniqueId">
/// The uniqueId DataSource of type <see cref="System.String"/>
/// </param>
/// <param name="name">
/// The name of the DataSource of type <see cref="System.String"/>
/// </param>
/// <param name="description">
/// Description of DataSource of type <see cref="System.String"/>
/// </param>
/// <param name="events">
/// A list of Event templates of type <see cref="T:System.Collection.Generic.List{Zeitgeist.Datamodel.Event}"/>
/// </param>
/// <returns>
/// true is successful, false otherwise <see cref="System.Boolean"/>
/// </returns>
public bool RegisterDataSources(string uniqueId, string name, string description, List<Event> events)
{
List<RawEvent> rawEventList = new List<RawEvent>();
foreach(Event src in events)
{
RawEvent evnt = src.GetRawEvent();
rawEventList.Add(evnt);
}
return srcInterface.RegisterDataSource(uniqueId, name, description, rawEventList.ToArray());
}
/// <summary>
/// Enables/Disables the DataSource identified by a uniqueId
/// </summary>
/// <param name="uniqueId">
/// The uniqueId of the DataSource of type <see cref="System.String"/>
/// </param>
/// <param name="enabled">
/// Is the DataSource to be enabled(true) or disabled(false) <see cref="System.Boolean"/>
/// </param>
void SetDataSourceEnabled(string uniqueId, bool enabled)
{
srcInterface.SetDataSourceEnabled(uniqueId, enabled);
}
/// <summary>
/// This signal is emitted whenever the last running instance of a data-source disconnects.
/// </summary>
public event DataSourceDisconnectedHandler DataSourceDisconnected;
/// <summary>
/// This signal is emitted whenever a data-source is enabled or disabled.
/// </summary>
public event DataSourceEnabledHandler DataSourceEnabled;
/// <summary>
/// This signal is emitted whenever a data-source registers itself.
/// </summary>
public event DataSourceRegisteredHandler DataSourceRegistered;
private IDataSource srcInterface;
private static string objectPath = "/org/gnome/zeitgeist/data_source_registry";
}
}
|
