Offline Instant Messaging v2 - Revision history

Diva at 01:05, 21 February 2013

2013-02-21T01:05:15Z

Allen Kerensky: Updated MySQL and OpenSim.ini bits for updated module commit r/22089

2013-02-19T14:49:28Z

Updated MySQL and OpenSim.ini bits for updated module commit r/22089

Allen Kerensky: created

2013-02-19T00:55:36Z

created

New page

= Offline Instant Messaging v2 =

Diva Canto has contributed a new Offline Instant Messaging v2 module for OpenSim 0.7.6-dev r/22086 and later.

To configure this, instead of the [[Offline Messaging]] module which requires an external PHP script.

== OpenSim.ini ==

Enabled the chosen instant messaging module in the [Messaging] block:

<source lang="ini">
[Messaging]
;# {OfflineMessageModule} {} {Module to use for offline message storage} {OfflineMessageModule "Offline Message Module V2" *}
;; Module to handle offline messaging. The core module requires an external
;; web service to do this. See OpenSim wiki.
; OfflineMessageModule = OfflineMessageModule
;; Or, alternatively, use this one, which works for both standalones and grids
; OfflineMessageModule = "Offline Message Module V2"

;# {OfflineMessageURL} {OfflineMessageModule:OfflineMessageModule Offline Message Module V2:Offline Message Module V2} {URL of offline messaging service} {}
;; URL of web service for offline message storage. Leave it commented if your service is local to the sim.
; OfflineMessageURL = http://yourserver/Offline.php or http://yourrobustserver:8003

;# {StorageProvider} {Offline Message Module V2:Offline Message Module V2} {DLL that provides the storage interface} {OpenSim.Addons.OfflineIM}
;; For standalones, use the service directly. This is the storage dll.
; StorageProvider = OpenSim.Addons.OfflineIM.dll

;# {MuteListModule} {OfflineMessageModule:OfflineMessageModule} {} {} MuteListModule
;; Mute list handler (not yet implemented). MUST BE SET to allow offline
;; messages to work
; MuteListModule = MuteListModule

;# {MuteListURL} {OfflineMessageModule:OfflineMessageModule} {} {} http://yourserver/Mute.php
;; URL of the web service that serves mute lists. Not currently used, but
;; must be set to allow offline messaging to work.
; MuteListURL = http://yourserver/Mute.php

;; Control whether group messages are forwarded to offline users.
;; Default is true.
;; This applies to the core groups module (Flotsam) only.
; ForwardOfflineGroupMessages = true
</source>

== Robust.ini ==
If you use a Robust server, the Robust.ini needs the following updates:

<source lang="ini">
[ServiceList]
... initial INI stuff

;; Uncomment this if you want offline IM to work
;OfflineIMServiceConnector = "8003/OpenSim.Addons.OfflineIM.dll:OfflineIMServiceRobustConnector"

... more INI stuff deleted ...

[Messaging]
; OfflineIM
StorageProvider = "OpenSim.Addons.OfflineIM.dll"
OfflineIMService = "OpenSim.Addons.OfflineIM.dll:OfflineIMService"
</source>

== Robust.HG.ini ==
If you use a Robust server with Hypergrid enabled, the Robust.HG.ini needs the following updates:
<source lang="ini">
[ServiceList]
... initial INI stuff

;; Uncomment this if you want offline IM to work
;OfflineIMServiceConnector = "8003/OpenSim.Addons.OfflineIM.dll:OfflineIMServiceRobustConnector"

... more INI stuff deleted ...

[Messaging]
; OfflineIM
StorageProvider = "OpenSim.Addons.OfflineIM.dll"
OfflineIMService = "OpenSim.Addons.OfflineIM.dll:OfflineIMService"
</source>

== MySQL Database ==
The Offline Instant Messaging v2 Module uses the following MySQL storage:
<source lang="sql">
:VERSION 1 # --------------------------

BEGIN;

CREATE TABLE `im_offline` (
`ID` MEDIUMINT NOT NULL AUTO_INCREMENT,
`PrincipalID` char(36) NOT NULL default '',
`Message` text NOT NULL,
`TMStamp` timestamp NOT NULL,
PRIMARY KEY (`ID`),
KEY `PrincipalID` (`PrincipalID`)
) ENGINE=MyISAM;

COMMIT;

:VERSION 2 # --------------------------

BEGIN;

INSERT INTO `im_offline` SELECT * from `diva_im_offline`;
DROP TABLE `diva_im_offline`;

COMMIT;
</source>

@@ Line 56: / Line 56: @@
 [Messaging]
      ; OfflineIM
      OfflineIMService = "OpenSim.Addons.OfflineIM.dll:OfflineIMService"
 </source>
@@ Line 73: / Line 72: @@
 [Messaging]
      ; OfflineIM
      OfflineIMService = "OpenSim.Addons.OfflineIM.dll:OfflineIMService"
 </source>

@@ Line 22: / Line 22: @@
      ; OfflineMessageURL = http://yourserver/Offline.php or http://yourrobustserver:8003
-     ;# {StorageProvider} {Offline Message Module V2:Offline Message Module V2} {DLL that provides the storage interface} {OpenSim.Addons.OfflineIM}
+     ;# {StorageProvider} {Offline Message Module V2:Offline Message Module V2} {DLL that provides the storage interface} {OpenSim.Data.MySQL.dll}
-	;; For standalones, use the service directly. This is the storage dll.
+	;; For standalones, this is the storage dll.
-	; StorageProvider = OpenSim.Addons.OfflineIM.dll
+	; StorageProvider = OpenSim.Data.MySQL.dll
      ;# {MuteListModule} {OfflineMessageModule:OfflineMessageModule} {} {} MuteListModule
@@ Line 78: / Line 78: @@
 == MySQL Database ==
-The Offline Instant Messaging v2 Module uses the following MySQL storage:
+The Offline Instant Messaging v2 Module uses the following MySQL storage and migrations:
   <source lang="sql">
 :VERSION 1         # --------------------------
@@ Line 101: / Line 101: @@
 INSERT INTO `im_offline` SELECT * from `diva_im_offline`;
 DROP TABLE `diva_im_offline`;
 COMMIT;
 </source>