~cszikszoy/do-plugins/pastebin

« back to all changes in this revision

Viewing changes to ManLookUp/src/ManLookUpAction.cs

  • Committer: Alex Launi
  • Date: 2008-10-20 01:44:13 UTC
  • mfrom: (256.1.1 do-plugins)
  • Revision ID: alex@eriktorvaldsonn-20081020014413-yugngt55h6vo4k4h
Added Man page lookup plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* ManLookUpAction.cs is part of ManLookUp, a Gnome-Do plugin
 
2
 *
 
3
 * Copyright 2008 J. Carlos Navea
 
4
 * loconet@gmail.com
 
5
 *
 
6
 * Man Look Up is the legal property of its developers. Please refer to the
 
7
 * COPYRIGHT file distributed with this
 
8
 * source distribution.
 
9
 *
 
10
 * This program is free software: you can redistribute it and/or modify
 
11
 * it under the terms of the GNU General Public License as published by
 
12
 * the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
18
 * GNU General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU General Public License
 
21
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 
22
 *
 
23
 * Contributors:
 
24
 * J. Carlos Navea <loconet@gmail.com>
 
25
 *
 
26
 * Based on the excellent work of sample plugins included with Gnome-Do 
 
27
 */
 
28
using System;
 
29
using Do.Universe;
 
30
using System.Diagnostics;
 
31
using System.Text.RegularExpressions;
 
32
 
 
33
using GConf;
 
34
using Mono.Unix;
 
35
 
 
36
 
 
37
namespace GnomeDoManLookUp {
 
38
 
 
39
        /// <summary>
 
40
        ///     ManLookUpAction - the main action for our plugin. 
 
41
        ///             Allows us to hook up to Gnome-Do as a command
 
42
        ///             that can be applied to raw text or our own man page items. 
 
43
        /// </summary>
 
44
        public class ManLookUpAction : AbstractAction {
 
45
                
 
46
                /// <value>
 
47
                ///     The name of the action
 
48
                /// </value>
 
49
                public override string Name {
 
50
                        get { return Catalog.GetString ("Read help documentation (man)"); }
 
51
                }
 
52
                
 
53
                /// <value>
 
54
                ///     Action's description
 
55
                /// </value>
 
56
                public override string Description {
 
57
                        get { return Catalog.GetString ("Look up and read a manual page (man)"); }
 
58
                }
 
59
                
 
60
                /// <value>
 
61
                ///     The pretty icon
 
62
                /// </value>    
 
63
                public override string Icon { 
 
64
                        get { return "applications-office"; }
 
65
                }
 
66
                
 
67
                /// <value>
 
68
                ///     List of supported items (ITextItem , ManLookUpItem)
 
69
                /// </value>
 
70
                public override Type[] SupportedItemTypes {
 
71
                        get {
 
72
                                return new Type[] {
 
73
                                        typeof(ITextItem),typeof(ManLookUpItem),typeof(ApplicationItem)
 
74
                                };
 
75
                        }
 
76
           
 
77
                }
 
78
                
 
79
                /// <summary>
 
80
                ///     Do we support the item?
 
81
                /// </summary>
 
82
                /// <param name="item">
 
83
                /// A <see cref="IItem"/>
 
84
                /// </param>
 
85
                /// <returns>
 
86
                /// A <see cref="System.Boolean"/>
 
87
                /// </returns>
 
88
                public override bool SupportsItem (IItem item) 
 
89
                {
 
90
                        
 
91
                        bool rc  = false;
 
92
                        string execStr;
 
93
 
 
94
                        if (!(item is ApplicationItem)) {                       
 
95
                                rc = true;                              
 
96
                        } else {
 
97
                                
 
98
                                ApplicationItem appItem = item as ApplicationItem;
 
99
 
 
100
                                //grab the parameter we'll be using for whatis command from the Exec string
 
101
                                //note, we use whatis becuase redirecting its output is a lot more efficient
 
102
                                //than that of a regular 'man page' which can contain thousands of lines. 
 
103
                                //man and whatis should use the same db anyways..
 
104
                                execStr = this.getExecutableName (appItem);
 
105
                                
 
106
                                //is there a matching man page?
 
107
                                if (execStr.Length > 0) {
 
108
                                        Process term                            = new Process ();
 
109
                                        term.StartInfo.FileName                 = "whatis";
 
110
                                        term.StartInfo.Arguments                = "'"+execStr+"'";
 
111
                                        term.StartInfo.UseShellExecute          = false;
 
112
                                        term.StartInfo.RedirectStandardOutput   = true;
 
113
                                        term.StartInfo.RedirectStandardError    = true;
 
114
                                        term.Start ();
 
115
                                        
 
116
                                        //if we don't put these, WaitForExit () blocks
 
117
                                        //on big buffers or ExitCode is not avalable yet..
 
118
                                        term.StandardOutput.ReadToEnd ();
 
119
                                        term.WaitForExit ();
 
120
                                        
 
121
                                        //if we didn't find a man page, we don't support it. 
 
122
                                        rc = term.ExitCode == 0;
 
123
                                }
 
124
                                
 
125
                                
 
126
                        }
 
127
                        
 
128
                        return rc;
 
129
                        
 
130
                }
 
131
                
 
132
                /// <summary>
 
133
                ///    Parse the <see cref="ApplicationItem"/> Exec string to attempt to obtain
 
134
                ///    name of the binary being executed so we may use it as a parameter for man
 
135
                /// </summary>
 
136
                /// <param name="appItem">
 
137
                /// A <see cref="ApplicationItem"/>
 
138
                /// </param>
 
139
                /// <returns>
 
140
                /// A <see cref="System.String"/>
 
141
                /// </returns>
 
142
                private static string getExecutableName (ApplicationItem appItem) 
 
143
                {                       
 
144
                        string execStr;
 
145
                        Match m;
 
146
                        Regex r;
 
147
                        int i;          
 
148
                        
 
149
                        // Now we parse the execute string to attempt to find a binary 
 
150
                        // name that we can look up a man page for. Ideally this should
 
151
                        // be given to us rather than guess the format but this
 
152
                        // will have to do for now.
 
153
                        // 1. if being invoked with gksu, ignore gksu itself and grab its parameter
 
154
                        // 2. remove any arguments sent to the call
 
155
                        // 3. reduce absolute paths to just the filename. 
 
156
                        //
 
157
                        r = new Regex ("^(gksu\\s+)?([^ ]+)\\s?.*$");
 
158
                        m = r.Match (appItem.Exec);                     
 
159
                        execStr = !m.Success ? appItem.Exec : execStr = m.Groups [2].ToString ();
 
160
                        
 
161
                        //grab base
 
162
                        i = execStr.LastIndexOf ('/');
 
163
                        if (i != -1)
 
164
                                execStr = execStr.Substring (i+1);
 
165
                        
 
166
                        return execStr;
 
167
                }
 
168
                
 
169
                /// <summary>
 
170
                ///     Called by Gnome-Do in order to perform our action.
 
171
                /// </summary>
 
172
                /// <param name="items">
 
173
                /// List of <see cref="IItem"/> objects, either raw text or custom look up items
 
174
                /// </param>
 
175
                /// <param name="modItems">
 
176
                /// List of <see cref="IItem"/> objects, action modifiers
 
177
                /// </param>
 
178
                /// <returns>
 
179
                /// List of <see cref="IItem"/>
 
180
                /// </returns>
 
181
                public override IItem[] Perform (IItem[] items, IItem[] modItems) 
 
182
                {
 
183
                        
 
184
                        string keyword = null;
 
185
 
 
186
                        //ok, was it plain text, an application item, or one of our own?
 
187
                        if (items [0] is ApplicationItem) {
 
188
                                keyword = this.getExecutableName (items [0] as ApplicationItem);
 
189
                        } else if (items [0] is ManLookUpItem) {
 
190
                                ManLookUpItem keyworditem = items [0] as ManLookUpItem;
 
191
                                keyword = keyworditem.Text;                                                     
 
192
                        } else {
 
193
                                ITextItem textitem = items [0] as ITextItem;
 
194
                                keyword = textitem.Text;                                 
 
195
                        }
 
196
                         
 
197
                        
 
198
                        if (keyword != null && keyword.Length > 0) {
 
199
                                Process term = new Process ();
 
200
                                term.StartInfo.FileName = "yelp";
 
201
                                term.StartInfo.Arguments = " 'man:"+keyword+"' ";                               
 
202
                                term.Start ();
 
203
                        }
 
204
                        
 
205
                        return null;
 
206
                }
 
207
        }
 
208
}