[0c60f96] | 1 | = Skype plugin for BitlBee |
---|
[668a122] | 2 | Miklos Vajna <vmiklos@vmiklos.hu> |
---|
[afe221f] | 3 | |
---|
[56e4ac4] | 4 | == Status |
---|
| 5 | |
---|
[4eaadf6] | 6 | [Wilmer van der Gaast (author of BitlBee)] |
---|
| 7 | ____ |
---|
| 8 | Okay, this exists now, with lots of thanks to vmiklos for his *excellent* |
---|
| 9 | work!! |
---|
| 10 | |
---|
| 11 | It's not in the main BitlBee and it'll never be for various reasons, but |
---|
| 12 | because it's a plugin that shouldn't be a problem. |
---|
| 13 | ____ |
---|
| 14 | |
---|
[56e4ac4] | 15 | One day I browsed the BitlBee bugtracker and found |
---|
| 16 | http://bugs.bitlbee.org/bitlbee/ticket/82[this] ticket. Then after a while I |
---|
[1138b25] | 17 | returned and saw that it was still open. So I wrote it. |
---|
[56e4ac4] | 18 | |
---|
[2042b56] | 19 | It's pretty stable, I use it for my daily work. Being a plug-in, no patching |
---|
[20994cb] | 20 | is required, you can just install it after installing BitlBee itself. |
---|
[75742cc] | 21 | |
---|
[4c3a4c8] | 22 | NOTE: You will see that this implementation of the Skype plug-in still requires |
---|
[54c269d] | 23 | a Skype instance to be running. This is because I'm not motivated to reverse |
---|
| 24 | engineer Skype's |
---|
| 25 | http://en.wikipedia.org/wiki/Skype_Protocol#Obfuscation_Layer[obfuscation |
---|
| 26 | layer]. (Not mentioning that you should ask your lawyer about if it is legal or |
---|
| 27 | not..) |
---|
| 28 | |
---|
[22d97b4] | 29 | == Requirements |
---|
| 30 | |
---|
[31fe322] | 31 | * Skype >= 1.4.0.99. The latest version I've tested is 2.0.0.63. |
---|
[36fbaa0] | 32 | * BitlBee >= 1.1.1dev. The latest version I've tested is 1.2. |
---|
[eb39102] | 33 | * Skype4Py >= 0.9.28.7. Previous versions won't work due to API changes. |
---|
[c60b864] | 34 | * Python >= 2.5. Skype4Py does not work with 2.4. |
---|
[e49da25] | 35 | * PyGObject >= 2.8.0. Older versions are part of PyGTK. (And you don't want to |
---|
| 36 | install GTK for nothing, right?) |
---|
[22d97b4] | 37 | |
---|
[df1a59d4] | 38 | `bitlbee-skype` has been tested under Linux and Mac OS X. Skype and Skype4py is |
---|
| 39 | available under Windows, too, so it probably works, but this has not been tested. |
---|
[760ed1f] | 40 | |
---|
[9e03e55] | 41 | == How to set it up |
---|
[afe221f] | 42 | |
---|
[751b149] | 43 | Before you start. The setup is the following: BitlBee can't connect directly to |
---|
| 44 | Skype servers (the company's ones). It needs a running Skype client to do so. |
---|
| 45 | In fact BitlBee will connect to `skyped` (a tcp server, provided in this |
---|
[4c3a4c8] | 46 | package) and `skyped` will connect to to your Skype client. |
---|
[751b149] | 47 | |
---|
[833eaee] | 48 | NOTE: The order is important. First `skyped` starts Skype. Then `skyped` can |
---|
| 49 | connect to Skype, finally BitlBee can connect to `skyped`. |
---|
[7e4f0ca1] | 50 | |
---|
[36fbaa0] | 51 | - If you happen to be a happy Frugalware user: |
---|
[11eed8f] | 52 | |
---|
[36fbaa0] | 53 | ---- |
---|
| 54 | # pacman-g2 -S bitlbee-skype |
---|
| 55 | ---- |
---|
| 56 | |
---|
| 57 | - You need the latest stable BitlBee release: |
---|
[afe221f] | 58 | |
---|
[0c60f96] | 59 | ---- |
---|
[36fbaa0] | 60 | $ wget http://get.bitlbee.org/src/bitlbee-1.2.tar.gz |
---|
| 61 | $ tar xf bitlbee-1.2.tar.gz |
---|
| 62 | $ cd bitlbee-1.2 |
---|
[0c60f96] | 63 | ---- |
---|
[afe221f] | 64 | |
---|
[d044a5a] | 65 | NOTE: You no longer need additional patches, as of version 1.1.1dev. |
---|
[b8b0bfd] | 66 | |
---|
[afe221f] | 67 | - Now compile and install it: |
---|
| 68 | |
---|
[0c60f96] | 69 | ---- |
---|
[ccb50f5] | 70 | $ ./configure |
---|
| 71 | $ make |
---|
| 72 | # make install install-dev |
---|
[0c60f96] | 73 | ---- |
---|
[afe221f] | 74 | |
---|
| 75 | - Get the plugin code: |
---|
| 76 | |
---|
[0c60f96] | 77 | ---- |
---|
[3b495c0] | 78 | $ wget http://vmiklos.hu/project/bitlbee-skype/bitlbee-skype-@VERSION@.tar.gz |
---|
| 79 | $ tar xf bitlbee-skype-@VERSION@.tar.gz |
---|
| 80 | $ cd bitlbee-skype-@VERSION@ |
---|
[0c60f96] | 81 | ---- |
---|
[afe221f] | 82 | |
---|
[3b495c0] | 83 | It doesn't matter where do you get it, it'll install the plugin to `/usr/local` |
---|
| 84 | by default (that's the location where BitlBee searches for plugins by default). |
---|
[6e97a7a] | 85 | |
---|
[afe221f] | 86 | - Compile and install it: |
---|
| 87 | |
---|
[0c60f96] | 88 | ---- |
---|
[ccb50f5] | 89 | $ ./configure |
---|
| 90 | $ make |
---|
| 91 | # make install |
---|
[0c60f96] | 92 | ---- |
---|
[afe221f] | 93 | |
---|
[c15f71a] | 94 | - Install http://skype4py.sourceforge.net/[Skype4Py]. |
---|
| 95 | |
---|
| 96 | (You may remember that previous versions of `skyped` did not require this |
---|
| 97 | package. This because it now uses the X11 interface of Skype (because the |
---|
[4c3a4c8] | 98 | previously used `DBus` interface had |
---|
[c15f71a] | 99 | http://forum.skype.com/index.php?s=&showtopic=94545&view=findpost&p=431710[known |
---|
| 100 | problems]), but I wanted to prevent a large code duplication from that project. |
---|
| 101 | In addition it then no longer requires the `dbus-python` package, just |
---|
| 102 | `pygobject`.) |
---|
| 103 | |
---|
[52d377d] | 104 | - Edit `/usr/local/etc/skyped/skyped.conf`: adjust `username` and `password`. The |
---|
[e65ceaa] | 105 | `username` should be your Skype login and the `password` can be whatever you |
---|
| 106 | want, but you will have to specify that one when adding the Skype account to |
---|
| 107 | BitlBee (see later). |
---|
| 108 | |
---|
[52d377d] | 109 | NOTE: Here, and later - `/usr/local/etc` can be different on your installation |
---|
| 110 | if you used the `--sysconfdir` switch when running bitlbee-skype's `configure`. |
---|
| 111 | |
---|
| 112 | - Generate the SSL pem files: |
---|
| 113 | |
---|
| 114 | ---- |
---|
[ccb50f5] | 115 | # cd /usr/local/etc/skyped |
---|
| 116 | # openssl req -new -x509 -days 365 -nodes -config skyped.cnf -out skyped.cert.pem \ |
---|
[52d377d] | 117 | -keyout skyped.key.pem |
---|
| 118 | ---- |
---|
| 119 | |
---|
[ccb50f5] | 120 | NOTE: Maybe you want to adjust the permissions in the `/usr/local/etc/skyped` |
---|
| 121 | dir. For example make it readable by just your user. |
---|
| 122 | |
---|
[833eaee] | 123 | - Start `skyped` (the tcp server): |
---|
[afe221f] | 124 | |
---|
[0c60f96] | 125 | ---- |
---|
[ccb50f5] | 126 | $ skyped |
---|
[0c60f96] | 127 | ---- |
---|
[ba20c39] | 128 | |
---|
[4c3a4c8] | 129 | - Start your `IRC` client, connect to BitlBee and add your account: |
---|
[7338d59] | 130 | |
---|
| 131 | ---- |
---|
[789d055] | 132 | account add skype <user> <pass> |
---|
| 133 | account set skype/server localhost |
---|
[7338d59] | 134 | ---- |
---|
| 135 | |
---|
[e65ceaa] | 136 | <user> should be your Skype account name, <pass> should be the one you declared |
---|
[10a42d9] | 137 | in `skyped.conf`. If you want to run skyped on a remote machine, replace |
---|
| 138 | `localhost` with the name of the machine. |
---|
[7338d59] | 139 | |
---|
[23b84e1] | 140 | == Setting up Skype in a VNC server (optional) |
---|
| 141 | |
---|
| 142 | Optionally, if you want to run Skype on a server, you might want to setup up |
---|
[4c3a4c8] | 143 | a `VNC` server as well. I used `tightvnc` but probably other `VNC` servers will |
---|
[23b84e1] | 144 | work, too. |
---|
| 145 | |
---|
| 146 | First run |
---|
| 147 | |
---|
| 148 | ---- |
---|
[ccb50f5] | 149 | $ vncpasswd ~/.vnc/passwd |
---|
[23b84e1] | 150 | ---- |
---|
| 151 | |
---|
| 152 | and create a password. You will need it at least once. |
---|
| 153 | |
---|
| 154 | Now create `~/.vnc/xstartup` with the following contents: |
---|
| 155 | |
---|
| 156 | ---- |
---|
| 157 | #!/bin/sh |
---|
| 158 | |
---|
[2dbb768] | 159 | twm |
---|
[23b84e1] | 160 | ---- |
---|
| 161 | |
---|
[57087df] | 162 | Adjust the permissions: |
---|
| 163 | |
---|
| 164 | ---- |
---|
[ccb50f5] | 165 | $ chmod +x ~/.vnc/xstartup |
---|
[57087df] | 166 | ---- |
---|
| 167 | |
---|
[23b84e1] | 168 | Then start the server: |
---|
| 169 | |
---|
| 170 | ---- |
---|
[ccb50f5] | 171 | $ vncserver |
---|
[23b84e1] | 172 | ---- |
---|
| 173 | |
---|
[2dbb768] | 174 | Then connect to it, and set up Skype (username, password, enable |
---|
| 175 | auto-login, start skyped and allow the `SkypeApiPythonShell` client when |
---|
| 176 | Skype asks about it). |
---|
[23b84e1] | 177 | |
---|
[dffa24f] | 178 | Please be aware about that Skype has serious memory leak issues. After running |
---|
| 179 | with for a few weeks it may eat >300 MB of memory. Just don't forget to restart |
---|
| 180 | your VNC server regularly. (How ugly.) |
---|
| 181 | |
---|
[123e45a] | 182 | == Features |
---|
[b6d26ac] | 183 | |
---|
[adce2de] | 184 | - Download nicks and away statuses from Skype |
---|
[b6d26ac] | 185 | |
---|
[39a0d64] | 186 | - Noticing joins / parts while we're connected |
---|
| 187 | |
---|
[93ece66] | 188 | - Sending messages |
---|
| 189 | |
---|
[8dd21bb] | 190 | - Receiving messages |
---|
| 191 | |
---|
[72f697b] | 192 | - Receiving away status changes |
---|
| 193 | |
---|
[62bb4e4] | 194 | - `skyped` (the tcp daemon that is a gateway between Skype and tcp) |
---|
[ed2e37f] | 195 | |
---|
[62bb4e4] | 196 | - Error handling when `skyped` is not running and when it exits |
---|
[afe221f] | 197 | |
---|
[62bb4e4] | 198 | - Marking received messages as seen so that Skype won't say there are unread messages |
---|
[440665b] | 199 | |
---|
[6627d92] | 200 | - Adding / removing contacts |
---|
| 201 | |
---|
[23411c6] | 202 | - Set away state when you do a `/away`. |
---|
| 203 | |
---|
[d3cbd17] | 204 | - When you `account off`, Skype will set status to `Offline` |
---|
[348a3a2] | 205 | |
---|
[d3cbd17] | 206 | - When you `account on`, Skype will set status to `Online` |
---|
[348a3a2] | 207 | |
---|
[d3cbd17] | 208 | - Detect when somebody wants to add you and ask for confirmation |
---|
[8dd21bb] | 209 | |
---|
[df9255d] | 210 | - Detect when somebody wants to transfer a file |
---|
| 211 | |
---|
[d6a371e] | 212 | - Group chat support: |
---|
| 213 | |
---|
| 214 | * Detect if we're invited |
---|
| 215 | |
---|
| 216 | * Send / receive group chat messages |
---|
[93ece66] | 217 | |
---|
[ff58445] | 218 | * Invite others (using `/invite <nick>`) |
---|
[c5dd164] | 219 | |
---|
[d6a371e] | 220 | * Part from group chats |
---|
[c5dd164] | 221 | |
---|
[ff58445] | 222 | * Starting a group chat (using `/j #nick`) |
---|
| 223 | |
---|
[e103e73] | 224 | - Topic changes in group chats: |
---|
| 225 | |
---|
| 226 | * Show the current topic (if any) on join |
---|
| 227 | |
---|
| 228 | * Notice when someone changes the topic |
---|
| 229 | |
---|
| 230 | * Support changing the topic using `/topic` |
---|
| 231 | |
---|
[fb36492] | 232 | - Viewing the profile using the `info` command. |
---|
| 233 | |
---|
[a06a0a5] | 234 | - Handling skype actions (when the `CHATMESSAGE` has `EMOTED` type) |
---|
| 235 | |
---|
[6b266f6] | 236 | - Setting your display name using the `nick` command. |
---|
[a06a0a5] | 237 | |
---|
[ccb50f5] | 238 | - Running Skype on a machine different to BitlBee is possible, the |
---|
| 239 | communication is encrypted. |
---|
| 240 | |
---|
[48181f0] | 241 | - Managing outgoing calls (with call duration at the end): |
---|
[2eb4b1f] | 242 | |
---|
| 243 | * `account set skype/call nick` |
---|
| 244 | * `account set -del skype/call` |
---|
[123e45a] | 245 | |
---|
[e0074cb] | 246 | - Managing incoming calls via questions, just like when you add / remove |
---|
| 247 | contacts. |
---|
[c5dd164] | 248 | |
---|
[e0074cb] | 249 | == What needs to be done (aka. TODO) |
---|
[846ceffb] | 250 | |
---|
[d6a371e] | 251 | - Notice if foo invites bar. Currently you can see only that bar joined. |
---|
| 252 | |
---|
[4285920] | 253 | - Public chats. See link:http://forum.skype.com/index.php?showtopic=98872[this |
---|
| 254 | forum thread], it is still unclear how could it be done for you to be able to |
---|
| 255 | `/join` to a public chat.. |
---|
[d6a371e] | 256 | |
---|
[3511d80] | 257 | - Add `--disable-skyped` and `--disable-plugin` switches in case one wants to |
---|
| 258 | build `bitlbee-skype` only for a public server or only for use with a public |
---|
| 259 | server. |
---|
[fdde7d8] | 260 | |
---|
[0c60f96] | 261 | == I would like to have support for ... |
---|
| 262 | |
---|
[23b84e1] | 263 | If something does not work and it's not in the TODO section, then please |
---|
[e72d869] | 264 | contact me! Please also try the link:HACKING[git version] before reporting a bug, your |
---|
[80d9004] | 265 | problem may be already fixed there. |
---|
[23b84e1] | 266 | |
---|
| 267 | In fact, of course, I wrote this documentation after figured out how to do this |
---|
| 268 | setup, so maybe I left out some steps. If you needed 'any' additional tricks, |
---|
| 269 | then it would be nice to include them here. |
---|
[afe221f] | 270 | |
---|
[f78f949] | 271 | == Known bugs |
---|
| 272 | |
---|
[5652d43] | 273 | - None at this time. |
---|
[f78f949] | 274 | |
---|
[0c60f96] | 275 | == Screenshots |
---|
| 276 | |
---|
[668a122] | 277 | You can reach some screenshots link:shot[here]. |
---|
[ddd3502] | 278 | |
---|
[25d87e4] | 279 | == Additional resources |
---|
[a60c3c2] | 280 | |
---|
[25d87e4] | 281 | You can reach the Changelog link:Changelog[here], and a gitweb interface |
---|
[6f01885] | 282 | http://vmiklos.hu/gitweb/?p=bitlbee-skype.git[here]. |
---|
[a60c3c2] | 283 | |
---|
[c09f90f] | 284 | The Skype API documentation is |
---|
| 285 | https://developer.skype.com/Docs/ApiDoc[here] if you're interested. |
---|
| 286 | |
---|
[ceee9c7] | 287 | |
---|
| 288 | == Testimonials |
---|
| 289 | |
---|
| 290 | ---- |
---|
| 291 | 00:56 < scathe> vmiklos: I like your skype plugin :) |
---|
| 292 | ---- |
---|
| 293 | |
---|
[6774d83] | 294 | ---- |
---|
| 295 | It's really working great so far. |
---|
| 296 | |
---|
| 297 | Good Job and thank you! |
---|
| 298 | Sebastian |
---|
| 299 | ---- |
---|
| 300 | |
---|
[65e4020] | 301 | == Thanks |
---|
| 302 | |
---|
| 303 | for the following people: |
---|
| 304 | |
---|
[e49da25] | 305 | * Wilmer van der Gaast, for answering questions about the BitlBee plugin interface |
---|
[65e4020] | 306 | |
---|
[56a3616] | 307 | * Arkadiusz Wahlig, author of skype4py, for making suggestions to skyped |
---|
[65e4020] | 308 | |
---|
[9834597] | 309 | * Gabor Adam Toth (tg), for noticing extra code is needed to handle multiline |
---|
| 310 | messages |
---|
| 311 | |
---|
| 312 | * Cristobal Palmer (tarheelcoxn), for helping to testing the plugin in a |
---|
| 313 | timezone different to mine |
---|
[65e4020] | 314 | |
---|
[437ddf5] | 315 | * people on `#bitlbee` for feedback |
---|
| 316 | |
---|
[eb9cbb8] | 317 | Back to my link:/projects[projects page]. |
---|
| 318 | |
---|
[0c60f96] | 319 | // vim: ft=asciidoc |
---|