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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Remmina - The GTK+ Remote Desktop Client: Example plugin to provide a new protocol</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="org.remmina.Remmina.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Remmina - The GTK+ Remote Desktop Client
 <span id="projectnumber">v1.4.33</span>
</div>
<div id="projectbrief">Remmina is a remote desktop client written in GTK+, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large monitors or tiny netbooks. Remmina supports multiple network protocols in an integrated and consistent user interface. Currently RDP, VNC, NX, XDMCP and SSH are supported.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('md__builds__remmina_remmina-ci__remmina_8wiki__development__plugin-_development__python__protocol-_example.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Example plugin to provide a new protocol </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="fragment"><div class="line">import sys</div><div class="line">import remmina</div><div class="line">import enum</div><div class="line">import gi</div><div class="line">import inspect</div><div class="line">gi.require_version("Gtk", "3.0")</div><div class="line">from gi.repository import Gtk, GLib</div><div class="line"></div><div class="line"></div><div class="line">class VncFeature:</div><div class="line">"""</div><div class="line"> Internal data struct to hold ids to feature settings.</div><div class="line">"""</div><div class="line"> PrefQuality = 1</div><div class="line"> PrefViewonly = 2</div><div class="line"> PrefDisableserverinput = 3</div><div class="line"> ToolRefresh = 4</div><div class="line"> ToolChat = 5</div><div class="line"> ToolSendCtrlAltDel = 6</div><div class="line"> Scale = 7</div><div class="line"> Unfocus = 8</div><div class="line"></div><div class="line">class VncData:</div><div class="line">"""</div><div class="line"> Internal data struct to hold state.</div><div class="line">"""</div><div class="line"> def __init__(self):</div><div class="line"> self.connected = False</div><div class="line"> self.running = False</div><div class="line"> self.auth_called = False</div><div class="line"> self.auth_first = False</div><div class="line"> self.drawing_area = False</div><div class="line"> self.vnc_buffer = False</div><div class="line"> self.rgb_buffer = False</div><div class="line"></div><div class="line">class Plugin:</div><div class="line">"""</div><div class="line"> Plugin implementation</div><div class="line">"""</div><div class="line"></div><div class="line"> def __init__(self):</div><div class="line"> # This constructor is called before Remmina attempts to register the plugin since it this class has to be instantiated before registering it.</div><div class="line"> self.name = "A short name of the plugin that also appears in the 'Plugin' column in the main dialog."</div><div class="line"> # One of possible values: "pref", "tool", "entry", "protocol" or "secret". This value decides which methods are expected to be defined</div><div class="line"> # in this class.</div><div class="line"> self.type = "protocol"</div><div class="line"> self.description = "VNC but in Python!"</div><div class="line"> self.version = "1.0"</div><div class="line"> self.icon_name = "org.remmina.Remmina-vnc-symbolic"</div><div class="line"> self.icon_name_ssh = "org.remmina.Remmina-vnc-ssh-symbolic"</div><div class="line"> # Specifies which settings are available for this protocol</div><div class="line"> self.ssh_setting = remmina.PROTOCOL_SSH_SETTING_TUNNEL</div><div class="line"></div><div class="line"> self.gpdata = VncData()</div><div class="line"> self.qualities = ("0", "Poor Pixelmess", "1","Mhh kayy", "2","Nice", "9","hot sh*t")</div><div class="line"> # Define the features this module supports:</div><div class="line"> self.features = [</div><div class="line"> remmina.Feature(</div><div class="line"> type=remmina.PROTOCOL_FEATURE_TYPE_PREF,</div><div class="line"> id=VncFeature.PrefQuality,</div><div class="line"> opt1=remmina.PROTOCOL_FEATURE_PREF_RADIO,</div><div class="line"> opt2="quality",</div><div class="line"> opt3=self.qualities)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_PREF, VncFeature.PrefViewonly, remmina.PROTOCOL_FEATURE_PREF_CHECK, "viewonly", None)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_PREF, VncFeature.PrefDisableserverinput, remmina.PROTOCOL_SETTING_TYPE_CHECK, "disableserverinput", "Disable server input")</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_TOOL, VncFeature.ToolRefresh, "Refresh", "face-smile", None)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_TOOL, VncFeature.ToolChat, "Open Chat…", "face-smile", None)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_TOOL, VncFeature.ToolSendCtrlAltDel, "Send Ctrl+Alt+Delete", None, None)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_SCALE, VncFeature.Scale, None, None, None)</div><div class="line"> ,remmina.Feature(remmina.PROTOCOL_FEATURE_TYPE_UNFOCUS, VncFeature.Unfocus, None, None, None)</div><div class="line"> ]</div><div class="line"></div><div class="line"> colordepths = ("8", "256 colors (8 bpp)", "16", "High color (16 bpp)", "32", "True color (32 bpp)")</div><div class="line"> self.basic_settings = [</div><div class="line"> remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_SERVER, name="server", label="", compact=False, opt1="_rfb._tcp",opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_TEXT, name="proxy", label="Repeater", compact=False, opt1=None, opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_TEXT, name="username", label="Username", compact=False, opt1=None, opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_PASSWORD,name="password", label="User password",compact=False, opt1=None, opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_SELECT, name="colordepth",label="Color depth", compact=False, opt1=colordepths,opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_SELECT, name="quality", label="Quality", compact=False, opt1=self.qualities, opt2=None)</div><div class="line"> , remmina.Setting(type=remmina.PROTOCOL_SETTING_TYPE_KEYMAP, name="keymap", label="", compact=False, opt1=None, opt2=None)</div><div class="line"> ]</div><div class="line"> self.advanced_settings = [</div><div class="line"> remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "showcursor", "Show remote cursor", True, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "viewonly", "View only", False, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "disableclipboard", "Disable clipboard sync", True, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "disableencryption", "Disable encryption", False, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "disableserverinput", "Disable server input", True, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "disablepasswordstoring", "Disable password storing", True, None, None)</div><div class="line"> , remmina.Setting(remmina.PROTOCOL_SETTING_TYPE_CHECK, "disablesmoothscrolling", "Disable smooth scrolling", True, None, None)</div><div class="line"> ]</div><div class="line"></div><div class="line"> def init(self, gp):</div><div class="line"> # this is called when the plugin is loaded from Remmina.</div><div class="line"> cfile = gp.get_file()</div><div class="line"> self.gpdata.disable_smooth_scrolling = cfile.get_setting(key="disablesmoothscrolling", default=False)</div><div class="line"> self.gpdata.drawing_area = gp.get_viewport()</div><div class="line"> return True</div><div class="line"></div><div class="line"> def open_connection(self, gp):</div><div class="line"> # Is called when the user wants to open a connection whith this plugin.</div><div class="line"></div><div class="line"> # Write code to initiate the connection. Example:</div><div class="line"> connection_file = gp.get_file()</div><div class="line"> connection_file.set_setting("disablepasswordstoring", False)</div><div class="line"> password = None</div><div class="line"></div><div class="line"> # Determine if passwords should not be allowed to be stored.</div><div class="line"> dont_save_passwords = connection_file.get_setting("disablepasswordstoring", False)</div><div class="line"> # Open a dialog prompting connection information and credentials</div><div class="line"> ret = remmina.protocol_plugin_init_auth(widget=gp,</div><div class="line"> flags= remmina.REMMINA_MESSAGE_PANEL_FLAG_USERNAME | remmina.REMMINA_MESSAGE_PANEL_FLAG_USERNAME_READONLY | remmina.REMMINA_MESSAGE_PANEL_FLAG_DOMAIN | remmina.REMMINA_MESSAGE_PANEL_FLAG_SAVEPASSWORD,</div><div class="line"> title="Python Rocks!",</div><div class="line"> default_username="",</div><div class="line"> default_password=connection_file.get_setting("password", ""),</div><div class="line"> default_domain="",</div><div class="line"> password_prompt="Your Password Rocks!")</div><div class="line"></div><div class="line"> # Process the result of the dialog</div><div class="line"> if ret == Gtk.ResponseType.CANCEL:</div><div class="line"> return False</div><div class="line"> elif ret == Gtk.ResponseType.OK:</div><div class="line"> # Indicate that the connection has been established!</div><div class="line"> remmina.protocol_plugin_signal_connection_opened(gp)</div><div class="line"></div><div class="line"> return True</div><div class="line"></div><div class="line"> def close_connection(self, gp):</div><div class="line"> # The user requested to close the connection.</div><div class="line"> remmina.protocol_plugin_signal_connection_closed(gp)</div><div class="line"></div><div class="line"> def query_feature(self, gp, feature):</div><div class="line"> # Remmina asks if the given feature is available (remember Features registered in the construtor).</div><div class="line"> return True</div><div class="line"></div><div class="line"> def map_event(self, gp):</div><div class="line"> # This is called when the widget is again on screen.</div><div class="line"> return True</div><div class="line"></div><div class="line"> def unmap_event(self, gp):</div><div class="line"> # This is called when the widget is again not being shown on screen anymore. Any intensive graphical output</div><div class="line"> # can be halted.</div><div class="line"> return True</div><div class="line"></div><div class="line"> def call_feature(self, gp, feature):</div><div class="line"> # Remmina asks to execute on of the features.</div><div class="line"></div><div class="line"> if feature.type == remmina.REMMINA_PROTOCOL_FEATURE_TYPE_PREF and feature.id is VncFeature.PrefQuality:</div><div class="line"> file = gp.get_file()</div><div class="line"> quality = file.get_setting("quality", 0)</div><div class="line"> if quality == 9:</div><div class="line"> print("Ramping up graphics. Enjoy!")</div><div class="line"> if quality == 0:</div><div class="line"> print("Squeezing image into a few pixels...")</div><div class="line"> if quality == 1:</div><div class="line"> print("More the average guy, eh?")</div><div class="line"> if quality == 2:</div><div class="line"> print("Not great, not terrible...")</div><div class="line"></div><div class="line"> def send_keystrokes(self, gp, strokes):</div><div class="line"> # Remmina received a key stroke and wants to pass it to the remote.</div><div class="line"> return True</div><div class="line"></div><div class="line"> def get_plugin_screenshot(self, gp, data):</div><div class="line"> # data is of type RemminaScreenshotData and should contain the raw pixels for the screenshot. Remmina takes care of storing it into a jpg.</div><div class="line"> # Return True when a screenshot has been done. Otherwise False.</div><div class="line"> return False</div><div class="line"></div><div class="line"># Instantiate & Register</div><div class="line">myPlugin = Plugin()</div><div class="line">remmina.register_plugin(myPlugin)</div></div><!-- fragment --> </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
