OpenSimulator - User contributions [en]

V2 Groups

2013-10-26T13:25:46Z

Richardus Raymaker: /* Region configuration example for HG enabled robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 

== Region configuration example for HG enabled robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server. 
This example is enabled for Hypergrid. 
The configuration options you can find in the opensim.ini file under the section [Groups]

'''This help section possible need improvements and corrections !!'''

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:23:26Z

Richardus Raymaker: /* Region configuration example for HG enabled robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 

== Region configuration example for HG enabled robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server. 
This example is enabled for Hypergrid. 
The configuration options you can find in the opensim.ini file under the section [Groups]

'''This help section can use improvements and corrections !!'''

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:18:29Z

Richardus Raymaker: /* jOpenSim */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 

== Region configuration example for HG enabled robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server. 
This example is enabled for Hypergrid. 
The configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:17:58Z

Richardus Raymaker: /* Region configuration example for connecting to robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== Region configuration example for HG enabled robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server. 
This example is enabled for Hypergrid. 
The configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:16:16Z

Richardus Raymaker: /* Region configuration example for connecting to robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== Region configuration example for connecting to robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server. 
The configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:15:28Z

Richardus Raymaker: /* Region configuration example for connecting to robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== Region configuration example for connecting to robust grid ==

This example file is for useing V2 groups on your region thats connected to a grid with robust as grid server.
The configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:13:40Z

Richardus Raymaker: /* Configuration example for robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== Region configuration example for connecting to robust grid ==

This example file is for V2 groups in grid setup with robust as grid server.
This configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:11:08Z

Richardus Raymaker: /* V2 groups configuration example for robust grid */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== Configuration example for robust grid ==

This example file is for V2 groups in grid setup with robust as grid server.
This configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T13:10:32Z

Richardus Raymaker: /* V2 groups configuration example */

As of OpenSimulator 0.7.6 Diva implemented the V2 Groups, which are now part of OpenSimulator core. Using the new groups do not need to use any third Party modules any more.

The below script helps, converting existing Flotsam Groups or jOpenSim Groups (which uses Flotsam anyway) to the new Groups. This ensures, that you dont lose any Group information, when you want to switch over.

== Differences between tables names ==
{|class="wikitable"
! jOpenSim
! Flotsam
! V2
|-
|jos_opensim_groupactive
|osagent
* AgentID
* ActiveGroupID
|os_groups_principals
* PrincipalID
* ActiveGroupID
|-
|jos_opensim_group
|osgroup
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MemberShipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|os_groups_groups
* GroupID
* Name
* Charter
* InsigniaID
* FounderID
* MembershipFee
* OpenEnrollment
* ShowInList
* AllowPublish
* MaturePublish
* OwnerRoleID
|-
|jos_opensim_groupinvite
|osgroupinvite
* InviteID
* GroupID
* RoleID
* AgentID
* TMStamp
|os_groups_invites
* InviteID
* GroupID
* RoleID
* PrincipalID
* TMStamp
|-
|jos_opensim_groupmembership
|osgroupmembership
* GroupID
* AgentID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|os_groups_membership
* GroupID
* PrincipalID
* SelectedRoleID
* Contribution
* ListInProfile
* AcceptNotices
|-
|jos_opensim_groupnotice
|osgroupnotice
* GroupID
* NoticeID
* Timestamp
* FromName
* Subject
* Message
|os_groups_notices
* GroupID
* NoticeID
* TMStamp
* FromName
* Subject
* Message
|-
|jos_opensim_grouprolemembership
|osgrouprolemembership
* GroupID
* RoleID
* AgentID
|os_groups_rolemembership
* GroupID
* RoleID
* PrincipalID
|-
|jos_opensim_grouprole
|osrole
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|os_groups_roles
* GroupID
* RoleID
* Name
* Description
* Title
* Powers
|}

== Notes ==

You do not need to consider the field '''BinaryBucket''' in the flotsam table '''osgroupnotice''' as long as you did not apply the patch attached to [http://opensimulator.org/mantis/view.php?id=6699 Mantis #6699]. If you have applied it, then maybe the following information will help, if you do not want to miss the content in the new tables:

Byte offset and description of bucket data:

* 0: 1 byte indicating if attachment is present
* 1: 1 byte indicating the type of attachment
* 2: 16 bytes - Group UUID
* 18: 16 bytes - UUID of the attachment owner
* 34: 16 bytes - UUID of the attachment
* 50: variable - Name of the attachment
* ??: NUL byte to terminate the attachment name

This information is copied from the original patch and describes the content format of field BinaryBucket.

== Flotsam ==
Use this script if your are using the Flotsam groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your Flotsam tables!):
<source lang=sql>
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
SELECT GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
FROM `FLOTSAMDB`.osgroup;

/*fill os_groups_invites in ROBUST database with values from osgroupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.osgroupinvite;

/*fill os_groups_membership in ROBUST database with values from osgroupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.osgroupmembership;

/*fill os_groups_notices in ROBUST database with values from osgroupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.osgroupnotice;

/*fill os_groups_principals in ROBUST database with values from osagent
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.osagent;

/*fill os_groups_rolemembership in ROBUST database with values from osrolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.osgrouprolemembership;

/*fill os_groups_roles in ROBUST database with values from osroles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.osrole;

</source>
== jOpenSim ==
Use this script if you are using the jOpenSim groups.

The Script (Replace ROBUSTDB with your ROBUST database and FLOTSAMDB with your database, containing your jOpenSim tables!):

<source lang=sql>

/* SQL script to convert group tables from Flotsam Groups (Group database) or jOpenSim (tables in Joomla Database)
to new V2 groups, which are part of OpenSimulator core up from 0.7.6 branch*/

/* FlotSam Tables latest version from
https://github.com/mcortez/flotsam/tree/master/flotsam/Servers/XmlRpcGroupsServer/
Commit-No.: 18275462c9*/

/* jOpenSim Version: 0.2.6.4*/

/*fill os_groups_groups in ROBUST database with values from jos_opensim_groups
or FlotSam osgroup*/
INSERT INTO `ROBUSTDB`.`os_groups_groups`
(GroupID, Name, Charter, InsigniaID, FounderID, MembershipFee, OpenEnrollment, ShowInList,
AllowPublish, MaturePublish, OwnerRoleID)
select GroupID, Name, Charter, InsigniaID, FounderID, MemberShipFee, OpenEnrollment, ShowInList, AllowPublish,
MaturePublish, OwnerRoleID
from `FLOTSAMDB`.jos_opensim_group;

/*fill os_groups_invites in ROBUST database with values from jos_opensim_groupinvite
or FlotSam osgroupinvite*/
INSERT INTO `ROBUSTDB`.`os_groups_invites`
(InviteID, GroupID, RoleID, PrincipalID, TMStamp)
SELECT InviteID, GroupID, RoleID, AgentID, TMStamp
FROM `FLOTSAMDB`.jos_opensim_groupinvite;

/*fill os_groups_membership in ROBUST database with values from jos_opensim_groupmembership
or FlotSam osgroupmembership*/
INSERT INTO `ROBUSTDB`.`os_groups_membership`
(GroupID, PrincipalID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices)
SELECT GroupID, AgentID, SelectedRoleID, Contribution, ListInProfile, AcceptNotices
FROM `FLOTSAMDB`.jos_opensim_groupmembership;

/*fill os_groups_notices in ROBUST database with values from jos_opensim_groupnotice
or FlotSam osgroupnotice*/
INSERT INTO `ROBUSTDB`.`os_groups_notices`
(GroupID, NoticeID, TMStamp, FromName, Subject, Message)
SELECT GroupID, NoticeID, Timestamp, FromName, Subject, Message
FROM `FLOTSAMDB`.jos_opensim_groupnotice;

/*fill os_groups_principals in ROBUST database with values from jos_opensim_groupactive
or FlotSam osagent*/
INSERT INTO `ROBUSTDB`.`os_groups_principals`
(PrincipalID, ActiveGroupID)
SELECT AgentID, ActiveGroupID
FROM `FLOTSAMDB`.jos_opensim_groupactive;

/*fill os_groups_rolemembership in ROBUST database with values from jos_opensim_grouprolemembership
or FlotSam osgrouprolemembership*/
INSERT INTO `ROBUSTDB`.os_groups_rolemembership
(GroupID, RoleID, PrincipalID)
SELECT GroupID, RoleID, AgentID
FROM `FLOTSAMDB`.jos_opensim_grouprolemembership;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_grouproles
or FlotSam osrole*/
INSERT INTO `ROBUSTDB`.os_groups_roles
(GroupID, RoleID, Name, Description, Title, Powers)
SELECT GroupID, RoleID, Name, Description, Title, Powers
FROM `FLOTSAMDB`.jos_opensim_grouprole;

/*fill os_groups_roles in ROBUST database with values from jos_opensim_offlinemessages
--> no corresponding table in FlotSam -- only applies to jOpenSim*/
INSERT INTO `ROBUSTDB`.im_offline
(PrincipalID, Message, TMStamp)
SELECT fromAgentID, Message, sent
FROM `FLOTSAMDB`.jos_opensim_offlinemessages;
</source>

 
== V2 groups configuration example for robust grid ==

This example file is for V2 groups in grid setup with robust as grid server.
This configuration options you can find in the opensim.ini file under the section [Groups]

<code>
;# {Enabled} {} {Enable groups?} {true false} false
;; Enables the groups module
 '''Enabled = true'''

;# {LevelGroupCreate} {Enabled:true} {User level for creating groups} {} 0
;; Minimum user level required to create groups
 '''LevelGroupCreate = 0'''

;# {Module} {Enabled:true} {Groups module to use? (Use GroupsModule to use Flotsam/Simian)} {Default "Groups Module V2"} Default
;; The default module can use a PHP XmlRpc server from the Flotsam project at
;; http://code.google.com/p/flotsam/
;; or from the SimianGrid project at http://code.google.com/p/openmetaverse
; Module = Default
;; or... use Groups Module V2, which works for standalones and robust grids
 '''Module = "Groups Module V2"'''

;# {StorageProvider} {Module:Groups Module V2} {The DLL that provides the storage for V2} {OpenSim.Data.MySQL.dll}
 '''StorageProvider = OpenSim.Data.MySQL.dll'''

;# {ServicesConnectorModule} {Module:GroupsModule Module:Groups Module V2} {Service connector to use for groups} {XmlRpcGroupsServicesConnector SimianGroupsServicesConnector "Groups Local Service Connector" "Groups Remote Service Connector" "Groups HG Service Connector"} XmlRpcGroupsServicesConnector
;; Service connectors to the Groups Service as used in the GroupsModule. Select one as follows:
;; -- for Flotsam Groups use XmlRpcGroupsServicesConnector
;; -- for Simian Groups use SimianGroupsServicesConnector
;; -- for V2 Groups, standalone, non-HG use "Groups Local Service Connector"
;; -- for V2 Groups, grided sim, non-HG use "Groups Remote Service Connector"
;; -- for V2 Groups, HG, both standalone and grided sim, use "Groups HG Service Connector"
;; Note that the quotes "" around the words are important!
; ServicesConnectorModule = XmlRpcGroupsServicesConnector
 '''ServicesConnectorModule = "Groups HG Service Connector"'''

;# {LocalService} {ServicesConnectorModule:Groups HG Service Connector} {Is the group service in this process or elsewhere?} {local remote} local
;; Used for V2 in HG only. If standalone, set this to local; if grided sim, set this to remote
; LocalService = local
 '''LocalService = remote'''

;# {GroupsServerURI} {Module:GroupsModule (ServicesConnectorModule:Groups Remote Service Connector or (ServicesConnectorModule:Groups HG Service Connector and LocalService:remote))} {Groups Server URI} {}
;; URI for the groups services of this grid
;; e.g. http://yourxmlrpcserver.com/xmlrpc.php for Flotsam XmlRpc
;; or http://mygridserver.com:82/Grid/ for SimianGrid
;; or http:://mygridserver.com:8003 for robust, V2
;; Leave it commented for standalones, V2
; GroupsServerURI = ""
 '''GroupsServerURI = "http://mygridserver.com:8003"'''

;# {HomeURI} {ServicesConnectorModule:Groups HG Service Connector} {What's the home address of this world?} {}
;; Used for V2 in HG only. For example
;; http://mygridserver.com:9000 or http://mygridserver.com:8002
;; If you have this set under [Startup], no need to set it here, leave it commented
 '''HomeURI = "http://mygridserver.com:8002"'''

;# {MessagingEnabled} {Module:GroupsModule Module:Groups Module V2} {Is groups messaging enabled?} {true false} true
 '''MessagingEnabled = true'''

;# {MessagingModule} {MessagingEnabled:true} {Module to use for groups messaging} {GroupsMessagingModule "Groups Messaging Module V2"} GroupsMessagingModule
; MessagingModule = GroupsMessagingModule
;; or use V2 for Groups V2
 '''MessagingModule = "Groups Messaging Module V2"'''

;# {NoticesEnabled} {Module:GroupsModule Module:Groups Module V2} {Enable group notices?} {true false} true
;; Enable Group Notices
 '''NoticesEnabled = true'''

;# {MessageOnlineUsersOnly} {Module:GroupsModule Module} {Message online users only?} {true false} false
; Experimental option to only message online users rather than all users
; Should make large groups with few online members messaging faster, as the expense of more calls to presence service
; Applies Flotsam Group only. V2 has this always on, no other option
 '''MessageOnlineUsersOnly = True'''
</code>

V2 Groups

2013-10-26T12:53:49Z

Richardus Raymaker: /* jOpenSim */

RemoteAdmin:admin create region

2013-08-09T10:48:26Z

Richardus Raymaker: /* PHP */

'''admin_create_region''' remotely allows to create a new regions and adds them to an estate. After creation the region is online and available in the map

=== Enabling admin create region ===
If not all functions are enabled, use admin_create_region to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_create_region,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_name''
| Name of the new region
|
|-
| ''listen_ip''
| listen ip to be used by region
|
|-
| ''listen_port''
| integer value of port
|
|-
| ''external_address''
| external address to be used by the region
|
|-
| ''region_x''
| region x location in grid
|
|-
| ''region_y''
| region y location in grid
|
|-
| ''estate_name''
| estate name that the new region belongs to. Specify estate owner if the estate does not exist yet
|
|}

=== Optional Parameters ===
These parameters are optional and do not need to be set

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_id''
| region uuid to be used for new region
|
|-
| estate_owner_uuid
| estate owner uuid (optionaly use estate_owner_first and estate_owner_last)
|
|-
| ''estate_owner_first''
| estate owners first name
|
|-
| ''estate_owner_last''
| estate owners last name
|
|-
| ''persist''
| saves new region configs to file e.g. region.ini
| true, false
|-
| ''region_file''
| when using persist you can specify the file to save region configs to (requires ''persist'' to be used)
|
|-
| ''public''
| enable/disable public access to new region
| true, false
|-
| ''enable_voice''
| enable/disable voice to new region
| true, false
|-
| ''heightmap_file''
| load a heightmap file once the new region has been created
|
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|-
| ''region_name''
| name of the new region
|
|-
| ''region_uuid''
| region uuid of the new region
|
|}

=== Error messages ===
When an error occures the following error value are returned

* cannot instantiate new region, server capacity {MAX REGION LIMIT} already reached; delete regions first
* region {UUID} already in use by region {REGION NAME}, UUID {REGION UUID}
* region name already in use by region {REGION NAME}, UUID {REGION UUID}
* region location <{X},{Y}> already in use by region {REGION NAME}, UUID {REGION UUID}
* region internal IP {IP} and port {PORT} already in use by {REGION NAME}, UUID {REGION UUID}
* Invalid location for region file.
* Specified user was not found.
* Estate owner details not provided.
* Failed to join estate.

== Notes ==
* When adding a region to a existing estate in the estate database, then one does not need to specify the estate owner. If the estate is does not exist or the estate exists with diffrent estate owners, then one has to use the ''estate_owner_uuid'' or ''estate_owner_first'' + ''estate_owner_last''.
* When using the optional ''persist'' parameter the region configs will be saved to the default region file. You can specify the file using the parameter region_file if you dont want to use the default

== Example ==
=== PHP ===
<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_region (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'listen_ip' => '0.0.0.0', 'listen_port' => '9001', 'region_x' => '1000', 'region_y' => '1000', 'estate_name' => 'My Estate');
$myRemoteAdmin->SendCommand('admin_create_region', $parameters);
?>
</source>

[[RemoteAdmin]]
[[RemoteAdmin:Commands]]

OpenSimSearch

2013-04-14T19:09:24Z

Richardus Raymaker: /* How to setup OSS */

__NOTOC__
{{Quicklinks}}
 

OpenSimSearch makes it possible to have working Search included in OpenSimulator. At this moment only the Popular Places, Places, Landsales are fully activate, Events works in basic mode, still working on Classifieds and in the future the "New" search that works with HTML pages.

== How to setup OSS ==

* Make sure you have a Apache/PHP/MySQL configuration ready else Search won't work!!

You can grab the latest version of OpenSimSearch through SVN, use the command below and use 'anonymous' as the username and a blank password to checkout the code.

<code>
svn checkout http://forge.opensimulator.org/svn/ossearch
</code>

you can find the ossearch code also at [http://forge.opensimulator.org/gf/project/ossearch/ http://forge.opensimulator.org/gf/project/ossearch/]

Note: For Windows users or those who have not used Subversion before, the [http://www.codinghorror.com/blog/2008/04/setting-up-subversion-on-windows.html instructions to set up the TortoiseSVN client on Windows] may be helpful (scroll down for the client part of the instructions). After you've installed TortoiseSVN, then create a directory in the location of your choosing and then right click - choose "SVN Checkout..." - and enter the URL provided above to download the entire package.

==== Using the Binary ====

===== The following parts are for the Grid owner only =====

* In the trunk/bin folder you can find the latest binary release which you can include into your OpenSim.Just grab the 2 binary files and place them in the '''bin''' folder of OpenSimulator.

* Copy all files in the trunk/webroot to your webserver

* Create a new database called '''ossearch'''

* Import the SQL file ossearch.sql into your database

<code>
mysql --user --password ossearch < ossearch.sql
</code>

* Make sure you change the databaseinfo.php file to reflect your settings.

<source lang=php>
<?php
$DB_HOST = "<servername>";
$DB_USER = "<username>";
$DB_PASSWORD = "<password>";
$DB_NAME = "<database>";
?>
</source>

===== The following parts are for the Region owners =====

* In the trunk/bin folder you can find the latest binary release which you can include into your OpenSim.Just grab the 2 binary files and place them in the '''bin''' folder of OpenSimulator.

* Search needs the DataSnapShot module to be activated, here's how to get it activated:

<source lang=text>
[DataSnapshot]
; The following set of configs pertains to search.
; Set index_sims to true to enable search engines to index your searchable data
; If false, no data will be exposed, DataSnapshot module will be off, and you can ignore the rest of
; these search-related configs
index_sims = true
; The variable data_exposure controls what the regions expose:
; minimum: exposes only things explicitly marked for search
; all: exposes everything
data_exposure = minimum
; If search is on, change this to your grid name; will be ignored for standalones
gridname = "<yourgridname>"
; Period between data snapshots, in seconds. 20 minutes, for starters, so that you see the initial changes fast.
; Later, you may want to increase this to 3600 (1 hour) or more
default_snapshot_period = 1200
; This will be created in bin, if it doesn't exist already. It will hold the data snapshots.
snapshot_cache_directory = "DataSnapshot"
; This semicolon-separated string serves to notify specific data services about the existence
; of this sim. Uncomment if you want to index your data with this and/or other search providers.
data_services="http://<yourserver>/search/register.php"
</source>

* Add the following 2 lines to your OpenSim.ini file to get Search activated

<code>
[Search] 
SearchURL = http://gridserver/search/query.php
</code>

===== [Grid owners] =====

* Startup your region server and check your MySQL database table '''hostregister''' if the regionserver registered itself. If it registers, that means the DataSnapShot Module is working and you can use Search.

In the trunk/webroot folder there's a file called parser.php. This file is the parser of the info from the DataSnapShot Module. This file needs to be run with cron or some other way. If this file isn't run, the search tables won't be filled and you won't see anything.

To set up a cron job, take a look at this page:

* http://www.linuxhelp.net/guides/cron/

===== [Region owners] =====

* Startup your region server and have the Grid owner check if your region shows up in the MySQL database table '''hostregister'''. When it does, your region now has Search enabled from the Grid

==== Notes for the Grid Owners ====

* If you're a Grid owner, make sure that regionserver can access your Search URL else the Search on those regions will fail.

* Whenever a sim fails, sometimes the user that has set the cron job up will fire off emails to the root user. These emails can be annoying but only give warnings about it working.

Profile based on mysqli

2013-03-27T13:07:14Z

Richardus Raymaker: /* STEP 2: profile.php */

__NOTOC__
{{Quicklinks}}

The OpenProfileModule makes it possible to create your own Profile and see other peoples' Profiles as well. 
This script is useing mysqli that replace the deprecated mysql commands with PHP 5.5.0

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OpenProfileModule Configuration Steps ===
The OpenProfileModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OpenProfileModule.

# Upload the profile.sql (below) to your database server
# Upload the profile.php (below) to your web server
# Enable the OpenProfileModule in your OpenSim.ini file

=== STEP 1: profile.sql ===
Save these SQL commands to a profile.sql file on your MySQL database server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `profile_classifieds`
(

`classifieduuid` char(36) NOT NULL,
`creatoruuid` char(36) NOT NULL,

`creationdate` int(20) NOT NULL,
`expirationdate` int(20) NOT NULL,

`category` varchar(20) NOT NULL,
`name` varchar(255) NOT NULL,

`description` text NOT NULL,
`parceluuid` char(36) NOT NULL,

`parentestate` int(11) NOT NULL,
`snapshotuuid` char(36) NOT NULL,

`simname` varchar(255) NOT NULL,
`posglobal` varchar(255) NOT NULL,

`parcelname` varchar(255) NOT NULL,
`classifiedflags` int(8) NOT NULL,

`priceforlisting` int(5) NOT NULL,
PRIMARY KEY (`classifieduuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_notes` (

`useruuid` varchar(36) NOT NULL,

`targetuuid` varchar(36) NOT NULL,

`notes` text NOT NULL,
UNIQUE KEY `useruuid` (`useruuid`,`targetuuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_picks` (

`pickuuid` varchar(36) NOT NULL,
`creatoruuid` varchar(36) NOT NULL,

`toppick` enum('true','false') NOT NULL,
`parceluuid` varchar(36) NOT NULL,

`name` varchar(255) NOT NULL,

`description` text NOT NULL,

`snapshotuuid` varchar(36) NOT NULL,

`user` varchar(255) NOT NULL,

`originalname` varchar(255) NOT NULL,

`simname` varchar(255) NOT NULL,

`posglobal` varchar(255) NOT NULL,

`sortorder` int(2) NOT NULL,

`enabled` enum('true','false') NOT NULL,
PRIMARY KEY (`pickuuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile` (

`useruuid` varchar(36) NOT NULL,

`profilePartner` varchar(36) NOT NULL,

`profileAllowPublish` binary(1) NOT NULL,

`profileMaturePublish` binary(1) NOT NULL,

`profileURL` varchar(255) NOT NULL,

`profileWantToMask` int(3) NOT NULL,

`profileWantToText` text NOT NULL,

`profileSkillsMask` int(3) NOT NULL,

`profileSkillsText` text NOT NULL,

`profileLanguages` text NOT NULL,

`profileImage` varchar(36) NOT NULL,

`profileAboutText` text NOT NULL,

`profileFirstImage` varchar(36) NOT NULL,

`profileFirstText` text NOT NULL,
PRIMARY KEY (`useruuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_settings` (

`useruuid` varchar(36) NOT NULL,

`imviaemail` enum('true','false') NOT NULL,

`visible` enum('true','false') NOT NULL,

`email` varchar(254) NOT NULL,
PRIMARY KEY (`useruuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the profile.sql file to configure your database to hold additional profile information:
<pre>
mysql> source profile.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: profile.php ===

Copy this PHP script to a file called profile.php and edit the following parameters in the script. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, Add the required data between the "" 

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the profile tables are stored
C_DB_USER = database user you are useing for accesing the profile database
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Profile */

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");

$zeroUUID = "00000000-0000-0000-0000-000000000000";
$xmlrpc_server = xmlrpc_server_create();

/*-------------------------*/
function openDB($dbHost,$dbUser,$dbPassword,$dbName)
{
/*Open database*/
$link = mysqli_connect($dbHost,$dbUser,$dbPassword,$dbName);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

return $link;
}

/*-------------------------*/
function closeDB($link)
{
/*Close database*/
mysqli_close($link);
}

/*-------------------------*/
function avatarclassifiedsrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['uuid'];

$result = mysqli_query($link,"SELECT * FROM profile_classifieds WHERE ".
"creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$data = array();

while (($row = mysqli_fetch_assoc($result)))
{
$data[] = array(
"classifiedid" => $row["classifieduuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Classifieds Update */
function classified_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];

$classifieduuid = $req['classifiedUUID'];
$creator = $req['creatorUUID'];
$category = $req['category'];
$name = $req['name'];
$description = $req['description'];
$parceluuid = $req['parcelUUID'];
$parentestate = $req['parentestate'];
$snapshotuuid = $req['snapshotUUID'];
$simname = $req['sim_name'];
$globalpos = $req['globalpos'];
$parcelname = $req['parcelname'];
$classifiedflag = $req['classifiedFlags'];
$priceforlist = $req['classifiedPrice'];

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_classifieds WHERE ".
"classifieduuid = '". mysqli_real_escape_string($link,$classifieduuid) ."'");

while ($row = mysqli_fetch_row($check))
{
$ready = $row[0];
}

if ($ready == 0)
{
/* Doing some late checking */
/* Should be done by the module but let's see what happens when */
/* I do it here */

if($parcelname == "")
$parcelname = "Unknown";

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

if($classifiedflag == 2)
{
$creationdate = time();
$expirationdate = time() + (7 * 24 * 60 * 60);
}
else
{
$creationdate = time();
$expirationdate = time() + (365 * 24 * 60 * 60);
}

$insertquery = "INSERT INTO profile_classifieds VALUES ".
"('". mysqli_real_escape_string($link,$classifieduuid) ."',".
"'". mysqli_real_escape_string($link,$creator) ."',".
"". mysqli_real_escape_string($link,$creationdate) .",".
"". mysqli_real_escape_string($link,$expirationdate) .",".
"'". mysqli_real_escape_string($link,$category) ."',".
"'". mysqli_real_escape_string($link,$name) ."',".
"'". mysqli_real_escape_string($link,$description) ."',".
"'". mysqli_real_escape_string($link,$parceluuid) ."',".
"". mysqli_real_escape_string($link,$parentestate) .",".
"'". mysqli_real_escape_string($link,$snapshotuuid) ."',".
"'". mysqli_real_escape_string($link,$simname) ."',".
"'". mysqli_real_escape_string($link,$globalpos) ."',".
"'". mysqli_real_escape_string($link,$parcelname) ."',".
"". mysqli_real_escape_string($link,$classifiedflag) .",".
"". mysqli_real_escape_string($link,$priceforlist) .")";

// Create a new record for this classified
$result = mysqli_query($link,$insertquery);
}
else
{

}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Classifieds Delete */
function classified_delete($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
$req = $params[0];

$classifieduuid = $req['classifiedID'];

$result = mysqli_query($link,"DELETE FROM profile_classifieds WHERE ".
"classifieduuid = '".mysqli_real_escape_string($link,$classifieduuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Picks Request */
function avatarpicksrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['uuid'];
$data = array();
$result = mysqli_query($link,"SELECT `pickuuid`,`name` FROM profile_picks WHERE ". "creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

while (($row = mysqli_fetch_assoc($result)))
{
$data[] = array(
"pickid" => $row["pickuuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Request Picks for User */
function pickinforequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$pick = $req['pick_id'];

$data = array();

$result = mysqli_query($link,"SELECT * FROM profile_picks WHERE ".
"creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"pickuuid = '". mysqli_real_escape_string($link,$pick) ."'");

$row = mysqli_fetch_assoc($result);
if ($row != False)
{
if ($row["description"] == null || $row["description"] == "")
$row["description"] = "No description given";

$data[] = array(
"pickuuid" => $row["pickuuid"],
"creatoruuid" => $row["creatoruuid"],
"toppick" => $row["toppick"],
"parceluuid" => $row["parceluuid"],
"name" => $row["name"],
"description" => $row["description"],
"snapshotuuid" => $row["snapshotuuid"],
"user" => $row["user"],
"originalname" => $row["originalname"],
"simname" => $row["simname"],
"posglobal" => $row["posglobal"],
"sortorder"=> $row["sortorder"],
"enabled" => $row["enabled"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Picks Update */
function picks_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];

$pickuuid = $req['pick_id'];
$creator = $req['creator_id'];
$toppick = $req['top_pick'];
$name = $req['name'];
$description = $req['desc'];
$parceluuid = $req['parcel_uuid'];
$snapshotuuid = $req['snapshot_id'];
$user = $req['user'];
$simname = $req['sim_name'];
$posglobal = $req['pos_global'];
$sortorder = $req['sort_order'];
$enabled = $req['enabled'];

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_picks WHERE ".
"pickuuid = '". mysqli_real_escape_string($link,$pickuuid) ."'");

$row = mysqli_fetch_row($check);

if ($row[0] == 0)
{
if($user == null || $user == "")
$user = "Unknown";

/* The original parcel name is the same as the name of the */
/* profile pick when a new profile pick is being created. */
$original = $name;

$query = "INSERT INTO profile_picks VALUES ".
"('". mysqli_real_escape_string($link,$pickuuid) ."',".
"'". mysqli_real_escape_string($link,$creator) ."',".
"'". mysqli_real_escape_string($link,$toppick) ."',".
"'". mysqli_real_escape_string($link,$parceluuid) ."',".
"'". mysqli_real_escape_string($link,$name) ."',".
"'". mysqli_real_escape_string($link,$description) ."',".
"'". mysqli_real_escape_string($link,$snapshotuuid) ."',".
"'". mysqli_real_escape_string($link,$user) ."',".
"'". mysqli_real_escape_string($link,$original) ."',".
"'". mysqli_real_escape_string($link,$simname) ."',".
"'". mysqli_real_escape_string($link,$posglobal) ."',".
"'". mysqli_real_escape_string($link,$sortorder) ."',".
"'". mysqli_real_escape_string($link,$enabled) ."')";
}
else
{
$query = "UPDATE profile_picks SET " .
"parceluuid = '". mysqli_real_escape_string($link,$parceluuid) . "', " .
"name = '". mysqli_real_escape_string($link,$name) . "', " .
"description = '". mysqli_real_escape_string($link,$description) . "', " .
"snapshotuuid = '". mysqli_real_escape_string($link,$snapshotuuid) . "' WHERE ".
"pickuuid = '". mysqli_real_escape_string($link,$pickuuid) ."'";
}

$result = mysqli_query($link,$query);
if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Picks Delete */
function picks_delete($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$pickuuid = $req['pick_id'];

$result = mysqli_query($link,"DELETE FROM profile_picks WHERE ".
"pickuuid = '".mysqli_real_escape_string($link,$pickuuid) ."'");

if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Notes Request */
function avatarnotesrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$targetuuid = $req['uuid'];

$result = mysqli_query($link,"SELECT notes FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");

$row = mysqli_fetch_row($result);
if ($row == False)
$notes = "";
else
$notes = $row[0];

$data[] = array(
"targetid" => $targetuuid,
"notes" => $notes);

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Notes Update */
function avatar_notes_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$targetuuid = $req['target_id'];
$notes = $req['notes'];

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");

$row = mysqli_fetch_row($check);

if ($row[0] == 0)
{
/* Create a new record for this avatar note */
$result = mysqli_query($link,"INSERT INTO profile_notes VALUES ".
"('". mysqli_real_escape_string($link,$uuid) ."',".
"'". mysqli_real_escape_string($link,$targetuuid) ."',".
"'". mysqli_real_escape_string($link,$notes) ."')");
}
else if ($notes == "")
{
/* Delete the record for this avatar note */
$result = mysqli_query($link,"DELETE FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");
}
else
{
/* Update the existing record */
$result = mysqli_query($link,"UPDATE profile_notes SET ".
"notes = '". mysqli_real_escape_string($link,$notes) ."' WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");
}

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Profile bits */
function avatar_properties_request($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];
$uuid = $req['avatar_id'];

$result = mysqli_query($link,"SELECT * FROM profile WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");
$row = mysqli_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"ProfileUrl" => $row["profileURL"],
"Image" => $row["profileImage"],
"AboutText" => $row["profileAboutText"],
"FirstLifeImage" => $row["profileFirstImage"],
"FirstLifeAboutText" => $row["profileFirstText"],
"Partner" => $row["profilePartner"],

//Return interest data along with avatar properties
"wantmask" => $row["profileWantToMask"],
"wanttext" => $row["profileWantToText"],
"skillsmask" => $row["profileSkillsMask"],
"skillstext" => $row["profileSkillsText"],
"languages" => $row["profileLanguages"]);
}
else
{
//Insert empty record for avatar.
//FIXME: Should this only be done when asking for ones own profile?
$sql = "INSERT INTO profile VALUES ( ".
"'". mysqli_real_escape_string($link,$uuid) ."', ".
"'$zeroUUID', 0, 0, '', 0, '', 0, '', '', ".
"'$zeroUUID', '', '$zeroUUID', '')";
$result = mysqli_query($link,$sql);

$data[] = array(
"ProfileUrl" => "",
"Image" => $zeroUUID,
"AboutText" => "",
"FirstLifeImage" => $zeroUUID,
"FirstLifeAboutText" => "",
"Partner" => $zeroUUID,

"wantmask" => 0,
"wanttext" => "",
"skillsmask" => 0,
"skillstext" => "",
"languages" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
function avatar_properties_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$profileURL = $req['ProfileUrl'];
$image = $req['Image'];
$abouttext = $req['AboutText'];
$firstlifeimage = $req['FirstLifeImage'];
$firstlifetext = $req['FirstLifeAboutText'];

$result=mysqli_query($link,"UPDATE profile SET ".
"profileURL='". mysqli_real_escape_string($link,$profileURL) ."', ".
"profileImage='". mysqli_real_escape_string($link,$image) ."', ".
"profileAboutText='". mysqli_real_escape_string($link,$abouttext) ."', ".
"profileFirstImage='". mysqli_real_escape_string($link,$firstlifeimage) ."', ".
"profileFirstText='". mysqli_real_escape_string($link,$firstlifetext) ."' ".
"WHERE useruuid='". mysqli_real_escape_string($link,$uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Profile Interests */
function avatar_interests_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$wanttext = $req['wanttext'];
$wantmask = $req['wantmask'];
$skillstext = $req['skillstext'];
$skillsmask = $req['skillsmask'];
$languages = $req['languages'];

$result = mysqli_query($link,"UPDATE profile SET ".
"profileWantToMask = ". mysqli_real_escape_string($link,$wantmask) .",".
"profileWantToText = '". mysqli_real_escape_string($link,$wanttext) ."',".
"profileSkillsMask = ". mysqli_real_escape_string($link,$skillsmask) .",".
"profileSkillsText = '". mysqli_real_escape_string($link,$skillstext) ."',".
"profileLanguages = '". mysqli_real_escape_string($link,$languages) ."' ".
"WHERE useruuid = '". mysqli_real_escape_string($link,$uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => True
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* User Preferences */
function user_preferences_request($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];

$result = mysqli_query($link,"SELECT imviaemail,visible,email FROM profile_settings WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$row = mysqli_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"imviaemail" => $row["imviaemail"],
"visible" => $row["visible"],
"email" => $row["email"]);
}
else
{
//Insert empty record for avatar.
//NOTE: The 'false' values here are enums defined in database
$sql = "INSERT INTO profile_settings VALUES ".
"('". mysqli_real_escape_string($link,$uuid) ."', ".
"'false', 'false', '')";
$result = mysqli_query($link,$sql);

$data[] = array(
"imviaemail" => False,
"visible" => False,
"email" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
function user_preferences_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$wantim = $req['imViaEmail'];
$directory = $req['visible'];

$result = mysqli_query($link,"UPDATE profile_settings SET ".
"imviaemail = '".mysqli_real_escape_string($link,$wantim) ."', ".
"visible = '".mysqli_real_escape_string($link,$directory) ."' WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
xmlrpc_server_register_method($xmlrpc_server, "avatarclassifiedsrequest","avatarclassifiedsrequest");
xmlrpc_server_register_method($xmlrpc_server, "classified_update","classified_update");
xmlrpc_server_register_method($xmlrpc_server, "classified_delete","classified_delete");
xmlrpc_server_register_method($xmlrpc_server, "avatarpicksrequest", "avatarpicksrequest");
xmlrpc_server_register_method($xmlrpc_server, "pickinforequest","pickinforequest");
xmlrpc_server_register_method($xmlrpc_server, "picks_update","picks_update");
xmlrpc_server_register_method($xmlrpc_server, "picks_delete","picks_delete");
xmlrpc_server_register_method($xmlrpc_server, "avatarnotesrequest","avatarnotesrequest");
xmlrpc_server_register_method($xmlrpc_server, "avatar_notes_update", "avatar_notes_update");
xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_request","avatar_properties_request");
xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_update","avatar_properties_update");
xmlrpc_server_register_method($xmlrpc_server, "avatar_interests_update","avatar_interests_update");
xmlrpc_server_register_method($xmlrpc_server, "user_preferences_request","user_preferences_request");
xmlrpc_server_register_method($xmlrpc_server, "user_preferences_update","user_preferences_update");

/* Process the request */
$request_xml = $HTTP_RAW_POST_DATA;
xmlrpc_server_call_method($xmlrpc_server, $request_xml, '');
xmlrpc_server_destroy($xmlrpc_server);
?>
</source >

=== STEP 3: OpenProfileModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Profile] block.

An example configuration is shown below:
<source lang="ini">
[Profile]
Module = "OpenProfileModule"
ProfileURL = "http://yourwebserverdomainname/pathto/profile.php"
</source>

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OpenProfileModule ===
Login to your simulator and try to create your profile.

Check the database profile table to verify whether or not profile.php has written a record there.

P.D: OpenProfileModule only works while you are on your home grid, not when you are connected to other grids over hypergrid.

=== Troubleshooting ===
Error shown in Apache error_log:
<pre style="color:red">
PHP Fatal error: Call to undefined function xmlrpc_server_create() in /var/www/html/opensim/profile.php
</pre>

Cause:
<pre>Many Linux distributions may not ship with PHP XML RPC extensions.</pre>

Steps to Fix:
* Fedora 17:
<pre>
# yum install php-xmlrpc
</pre>

Profile

2013-03-27T13:03:16Z

Richardus Raymaker:

__NOTOC__
{{Quicklinks}}

The OpenProfileModule makes it possible to create your own Profile and see other peoples' Profiles as well.

You can find a newer script thats useing mysqli that replace the deprecated mysql commands with PHP 5.5.0
[http://opensimulator.org/wiki/Profile_based_on_mysqli here]

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OpenProfileModule Configuration Steps ===
The OpenProfileModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OpenProfileModule.

# Upload the profile.sql (below) to your database server
# Upload the profile.php (below) to your web server
# Enable the OpenProfileModule in your OpenSim.ini file

=== STEP 1: profile.sql ===
Save these SQL commands to a profile.sql file on your MySQL database server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `profile_classifieds`
(

`classifieduuid` char(36) NOT NULL,
`creatoruuid` char(36) NOT NULL,

`creationdate` int(20) NOT NULL,
`expirationdate` int(20) NOT NULL,

`category` varchar(20) NOT NULL,
`name` varchar(255) NOT NULL,

`description` text NOT NULL,
`parceluuid` char(36) NOT NULL,

`parentestate` int(11) NOT NULL,
`snapshotuuid` char(36) NOT NULL,

`simname` varchar(255) NOT NULL,
`posglobal` varchar(255) NOT NULL,

`parcelname` varchar(255) NOT NULL,
`classifiedflags` int(8) NOT NULL,

`priceforlisting` int(5) NOT NULL,
PRIMARY KEY (`classifieduuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_notes` (

`useruuid` varchar(36) NOT NULL,

`targetuuid` varchar(36) NOT NULL,

`notes` text NOT NULL,
UNIQUE KEY `useruuid` (`useruuid`,`targetuuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_picks` (

`pickuuid` varchar(36) NOT NULL,
`creatoruuid` varchar(36) NOT NULL,

`toppick` enum('true','false') NOT NULL,
`parceluuid` varchar(36) NOT NULL,

`name` varchar(255) NOT NULL,

`description` text NOT NULL,

`snapshotuuid` varchar(36) NOT NULL,

`user` varchar(255) NOT NULL,

`originalname` varchar(255) NOT NULL,

`simname` varchar(255) NOT NULL,

`posglobal` varchar(255) NOT NULL,

`sortorder` int(2) NOT NULL,

`enabled` enum('true','false') NOT NULL,
PRIMARY KEY (`pickuuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile` (

`useruuid` varchar(36) NOT NULL,

`profilePartner` varchar(36) NOT NULL,

`profileAllowPublish` binary(1) NOT NULL,

`profileMaturePublish` binary(1) NOT NULL,

`profileURL` varchar(255) NOT NULL,

`profileWantToMask` int(3) NOT NULL,

`profileWantToText` text NOT NULL,

`profileSkillsMask` int(3) NOT NULL,

`profileSkillsText` text NOT NULL,

`profileLanguages` text NOT NULL,

`profileImage` varchar(36) NOT NULL,

`profileAboutText` text NOT NULL,

`profileFirstImage` varchar(36) NOT NULL,

`profileFirstText` text NOT NULL,
PRIMARY KEY (`useruuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_settings` (

`useruuid` varchar(36) NOT NULL,

`imviaemail` enum('true','false') NOT NULL,

`visible` enum('true','false') NOT NULL,

`email` varchar(254) NOT NULL,
PRIMARY KEY (`useruuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the profile.sql file to configure your database to hold additional profile information:
<pre>
mysql> source profile.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: profile.php ===
Copy this PHP script to a file called profile.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?PHP
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

mysql_connect ($dbHost,$dbUser,$dbPassword);
mysql_select_db ($dbName);

$zeroUUID = "00000000-0000-0000-0000-000000000000";
$xmlrpc_server = xmlrpc_server_create();

xmlrpc_server_register_method($xmlrpc_server, "avatarclassifiedsrequest",
"avatarclassifiedsrequest");

function avatarclassifiedsrequest($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['uuid'];

$result = mysql_query("SELECT * FROM profile_classifieds WHERE ".
"creatoruuid = '". mysql_escape_string($uuid) ."'");

$data = array();

while (($row = mysql_fetch_assoc($result)))
{
$data[] = array(
"classifiedid" => $row["classifieduuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

# Classifieds Update

xmlrpc_server_register_method($xmlrpc_server, "classified_update",
"classified_update");

function classified_update($method_name, $params, $app_data)
{
global $zeroUUID;

$req = $params[0];

$classifieduuid = $req['classifiedUUID'];
$creator = $req['creatorUUID'];
$category = $req['category'];
$name = $req['name'];
$description = $req['description'];
$parceluuid = $req['parcelUUID'];
$parentestate = $req['parentestate'];
$snapshotuuid = $req['snapshotUUID'];
$simname = $req['sim_name'];
$globalpos = $req['globalpos'];
$parcelname = $req['parcelname'];
$classifiedflag = $req['classifiedFlags'];
$priceforlist = $req['classifiedPrice'];

// Check if we already have this one in the database
$check = mysql_query("SELECT COUNT(*) FROM profile_classifieds WHERE ".
"classifieduuid = '". mysql_escape_string($classifieduuid) ."'");

while ($row = mysql_fetch_row($check))
{
$ready = $row[0];
}

if ($ready == 0)
{
// Doing some late checking
// Should be done by the module but let's see what happens when
// I do it here

if($parcelname == "")
$parcelname = "Unknown";

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

if($classifiedflag == 2)
{
$creationdate = time();
$expirationdate = time() + (7 * 24 * 60 * 60);
}
else
{
$creationdate = time();
$expirationdate = time() + (365 * 24 * 60 * 60);
}

$insertquery = "INSERT INTO profile_classifieds VALUES ".
"('". mysql_escape_string($classifieduuid) ."',".
"'". mysql_escape_string($creator) ."',".
"". mysql_escape_string($creationdate) .",".
"". mysql_escape_string($expirationdate) .",".
"'". mysql_escape_string($category) ."',".
"'". mysql_escape_string($name) ."',".
"'". mysql_escape_string($description) ."',".
"'". mysql_escape_string($parceluuid) ."',".
"". mysql_escape_string($parentestate) .",".
"'". mysql_escape_string($snapshotuuid) ."',".
"'". mysql_escape_string($simname) ."',".
"'". mysql_escape_string($globalpos) ."',".
"'". mysql_escape_string($parcelname) ."',".
"". mysql_escape_string($classifiedflag) .",".
"". mysql_escape_string($priceforlist) .")";

// Create a new record for this classified
$result = mysql_query($insertquery);
}
else
{

}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

# Classifieds Delete

xmlrpc_server_register_method($xmlrpc_server, "classified_delete",
"classified_delete");

function classified_delete($method_name, $params, $app_data)
{
$req = $params[0];

$classifieduuid = $req['classifiedID'];

$result = mysql_query("DELETE FROM profile_classifieds WHERE ".
"classifieduuid = '".mysql_escape_string($classifieduuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

#
# Picks
#

# Avatar Picks Request

xmlrpc_server_register_method($xmlrpc_server, "avatarpicksrequest", "avatarpicksrequest");

function avatarpicksrequest($method_name, $params, $app_data)
{
$req = $params[0];
$uuid = $req['uuid'];
$data = array();
$result = mysql_query("SELECT `pickuuid`,`name` FROM profile_picks WHERE ". "creatoruuid = '". mysql_escape_string($uuid) ."'");

while (($row = mysql_fetch_assoc($result)))
{
$data[] = array(
"pickid" => $row["pickuuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

# Request Picks for User

xmlrpc_server_register_method($xmlrpc_server, "pickinforequest",
"pickinforequest");

function pickinforequest($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];
$pick = $req['pick_id'];

$data = array();

$result = mysql_query("SELECT * FROM profile_picks WHERE ".
"creatoruuid = '". mysql_escape_string($uuid) ."' AND ".
"pickuuid = '". mysql_escape_string($pick) ."'");

$row = mysql_fetch_assoc($result);
if ($row != False)
{
if ($row["description"] == null || $row["description"] == "")
$row["description"] = "No description given";

$data[] = array(
"pickuuid" => $row["pickuuid"],
"creatoruuid" => $row["creatoruuid"],
"toppick" => $row["toppick"],
"parceluuid" => $row["parceluuid"],
"name" => $row["name"],
"description" => $row["description"],
"snapshotuuid" => $row["snapshotuuid"],
"user" => $row["user"],
"originalname" => $row["originalname"],
"simname" => $row["simname"],
"posglobal" => $row["posglobal"],
"sortorder"=> $row["sortorder"],
"enabled" => $row["enabled"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

# Picks Update

xmlrpc_server_register_method($xmlrpc_server, "picks_update",
"picks_update");

function picks_update($method_name, $params, $app_data)
{
global $zeroUUID;

$req = $params[0];

$pickuuid = $req['pick_id'];
$creator = $req['creator_id'];
$toppick = $req['top_pick'];
$name = $req['name'];
$description = $req['desc'];
$parceluuid = $req['parcel_uuid'];
$snapshotuuid = $req['snapshot_id'];
$user = $req['user'];
$simname = $req['sim_name'];
$posglobal = $req['pos_global'];
$sortorder = $req['sort_order'];
$enabled = $req['enabled'];

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

// Check if we already have this one in the database
$check = mysql_query("SELECT COUNT(*) FROM profile_picks WHERE ".
"pickuuid = '". mysql_escape_string($pickuuid) ."'");

$row = mysql_fetch_row($check);

if ($row[0] == 0)
{
if($user == null || $user == "")
$user = "Unknown";

//The original parcel name is the same as the name of the
//profile pick when a new profile pick is being created.
$original = $name;

$query = "INSERT INTO profile_picks VALUES ".
"('". mysql_escape_string($pickuuid) ."',".
"'". mysql_escape_string($creator) ."',".
"'". mysql_escape_string($toppick) ."',".
"'". mysql_escape_string($parceluuid) ."',".
"'". mysql_escape_string($name) ."',".
"'". mysql_escape_string($description) ."',".
"'". mysql_escape_string($snapshotuuid) ."',".
"'". mysql_escape_string($user) ."',".
"'". mysql_escape_string($original) ."',".
"'". mysql_escape_string($simname) ."',".
"'". mysql_escape_string($posglobal) ."',".
"'". mysql_escape_string($sortorder) ."',".
"'". mysql_escape_string($enabled) ."')";
}
else
{
$query = "UPDATE profile_picks SET " .
"parceluuid = '". mysql_escape_string($parceluuid) . "', " .
"name = '". mysql_escape_string($name) . "', " .
"description = '". mysql_escape_string($description) . "', " .
"snapshotuuid = '". mysql_escape_string($snapshotuuid) . "' WHERE ".
"pickuuid = '". mysql_escape_string($pickuuid) ."'";
}

$result = mysql_query($query);
if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysql_error()
));

print $response_xml;
}

# Picks Delete

xmlrpc_server_register_method($xmlrpc_server, "picks_delete",
"picks_delete");

function picks_delete($method_name, $params, $app_data)
{
$req = $params[0];

$pickuuid = $req['pick_id'];

$result = mysql_query("DELETE FROM profile_picks WHERE ".
"pickuuid = '".mysql_escape_string($pickuuid) ."'");

if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysql_error()
));

print $response_xml;
}

#
# Notes
#

# Avatar Notes Request

xmlrpc_server_register_method($xmlrpc_server, "avatarnotesrequest",
"avatarnotesrequest");

function avatarnotesrequest($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];
$targetuuid = $req['uuid'];

$result = mysql_query("SELECT notes FROM profile_notes WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."' AND ".
"targetuuid = '". mysql_escape_string($targetuuid) ."'");

$row = mysql_fetch_row($result);
if ($row == False)
$notes = "";
else
$notes = $row[0];

$data[] = array(
"targetid" => $targetuuid,
"notes" => $notes);

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

# Avatar Notes Update

xmlrpc_server_register_method($xmlrpc_server, "avatar_notes_update",
"avatar_notes_update");

function avatar_notes_update($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];
$targetuuid = $req['target_id'];
$notes = $req['notes'];

// Check if we already have this one in the database

$check = mysql_query("SELECT COUNT(*) FROM profile_notes WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."' AND ".
"targetuuid = '". mysql_escape_string($targetuuid) ."'");

$row = mysql_fetch_row($check);

if ($row[0] == 0)
{
// Create a new record for this avatar note
$result = mysql_query("INSERT INTO profile_notes VALUES ".
"('". mysql_escape_string($uuid) ."',".
"'". mysql_escape_string($targetuuid) ."',".
"'". mysql_escape_string($notes) ."')");
}
else if ($notes == "")
{
// Delete the record for this avatar note
$result = mysql_query("DELETE FROM profile_notes WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."' AND ".
"targetuuid = '". mysql_escape_string($targetuuid) ."'");
}
else
{
// Update the existing record
$result = mysql_query("UPDATE profile_notes SET ".
"notes = '". mysql_escape_string($notes) ."' WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."' AND ".
"targetuuid = '". mysql_escape_string($targetuuid) ."'");
}

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysql_error()
));

print $response_xml;
}

# Profile bits

xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_request",
"avatar_properties_request");

function avatar_properties_request($method_name, $params, $app_data)
{
global $zeroUUID;

$req = $params[0];

$uuid = $req['avatar_id'];

$result = mysql_query("SELECT * FROM profile WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."'");
$row = mysql_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"ProfileUrl" => $row["profileURL"],
"Image" => $row["profileImage"],
"AboutText" => $row["profileAboutText"],
"FirstLifeImage" => $row["profileFirstImage"],
"FirstLifeAboutText" => $row["profileFirstText"],
"Partner" => $row["profilePartner"],

//Return interest data along with avatar properties
"wantmask" => $row["profileWantToMask"],
"wanttext" => $row["profileWantToText"],
"skillsmask" => $row["profileSkillsMask"],
"skillstext" => $row["profileSkillsText"],
"languages" => $row["profileLanguages"]);
}
else
{
//Insert empty record for avatar.
//FIXME: Should this only be done when asking for ones own profile?
$sql = "INSERT INTO profile VALUES ( ".
"'". mysql_escape_string($uuid) ."', ".
"'$zeroUUID', 0, 0, '', 0, '', 0, '', '', ".
"'$zeroUUID', '', '$zeroUUID', '')";
$result = mysql_query($sql);

$data[] = array(
"ProfileUrl" => "",
"Image" => $zeroUUID,
"AboutText" => "",
"FirstLifeImage" => $zeroUUID,
"FirstLifeAboutText" => "",
"Partner" => $zeroUUID,

"wantmask" => 0,
"wanttext" => "",
"skillsmask" => 0,
"skillstext" => "",
"languages" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_update",
"avatar_properties_update");

function avatar_properties_update($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];
$profileURL = $req['ProfileUrl'];
$image = $req['Image'];
$abouttext = $req['AboutText'];
$firstlifeimage = $req['FirstLifeImage'];
$firstlifetext = $req['FirstLifeAboutText'];

$result=mysql_query("UPDATE profile SET ".
"profileURL='". mysql_escape_string($profileURL) ."', ".
"profileImage='". mysql_escape_string($image) ."', ".
"profileAboutText='". mysql_escape_string($abouttext) ."', ".
"profileFirstImage='". mysql_escape_string($firstlifeimage) ."', ".
"profileFirstText='". mysql_escape_string($firstlifetext) ."' ".
"WHERE useruuid='". mysql_escape_string($uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysql_error()
));

print $response_xml;
}

// Profile Interests

xmlrpc_server_register_method($xmlrpc_server, "avatar_interests_update",
"avatar_interests_update");

function avatar_interests_update($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];
$wanttext = $req['wanttext'];
$wantmask = $req['wantmask'];
$skillstext = $req['skillstext'];
$skillsmask = $req['skillsmask'];
$languages = $req['languages'];

$result = mysql_query("UPDATE profile SET ".
"profileWantToMask = ". mysql_escape_string($wantmask) .",".
"profileWantToText = '". mysql_escape_string($wanttext) ."',".
"profileSkillsMask = ". mysql_escape_string($skillsmask) .",".
"profileSkillsText = '". mysql_escape_string($skillstext) ."',".
"profileLanguages = '". mysql_escape_string($languages) ."' ".
"WHERE useruuid = '". mysql_escape_string($uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => True
));

print $response_xml;
}

// User Preferences

xmlrpc_server_register_method($xmlrpc_server, "user_preferences_request",
"user_preferences_request");

function user_preferences_request($method_name, $params, $app_data)
{
$req = $params[0];

$uuid = $req['avatar_id'];

$result = mysql_query("SELECT imviaemail,visible,email FROM profile_settings WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."'");

$row = mysql_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"imviaemail" => $row["imviaemail"],
"visible" => $row["visible"],
"email" => $row["email"]);
}
else
{
//Insert empty record for avatar.
//NOTE: The 'false' values here are enums defined in database
$sql = "INSERT INTO profile_settings VALUES ".
"('". mysql_escape_string($uuid) ."', ".
"'false', 'false', '')";
$result = mysql_query($sql);

$data[] = array(
"imviaemail" => False,
"visible" => False,
"email" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

xmlrpc_server_register_method($xmlrpc_server, "user_preferences_update",
"user_preferences_update");

function user_preferences_update($method_name, $params, $app_data)
{

$req = $params[0];

$uuid = $req['avatar_id'];
$wantim = $req['imViaEmail'];
$directory = $req['visible'];

$result = mysql_query("UPDATE profile_settings SET ".
"imviaemail = '".mysql_escape_string($wantim) ."', ".
"visible = '".mysql_escape_string($directory) ."' WHERE ".
"useruuid = '". mysql_escape_string($uuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
}

#
# Process the request
#

$request_xml = $HTTP_RAW_POST_DATA;
xmlrpc_server_call_method($xmlrpc_server, $request_xml, '');
xmlrpc_server_destroy($xmlrpc_server);
?>

</source >

=== STEP 3: OpenProfileModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Profile] block.

An example configuration is shown below:
<source lang="ini">
[Profile]
Module = "OpenProfileModule"
ProfileURL = "http://yourwebserverdomainname/pathto/profile.php"
</source>

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OpenProfileModule ===
Login to your simulator and try to create your profile.

Check the database profile table to verify whether or not profile.php has written a record there.

P.D: OpenProfileModule only works while you are on your home grid, not when you are connected to other grids over hypergrid.

=== Troubleshooting ===
Error shown in Apache error_log:
<pre style="color:red">
PHP Fatal error: Call to undefined function xmlrpc_server_create() in /var/www/html/opensim/profile.php
</pre>

Cause:
<pre>Many Linux distributions may not ship with PHP XML RPC extensions.</pre>

Steps to Fix:
* Fedora 17:
<pre>
# yum install php-xmlrpc
</pre>

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Profile based on mysqli

2013-03-27T13:00:40Z

Richardus Raymaker: Created page with "__NOTOC__ {{Quicklinks}} The OpenProfileModule makes it possible to create your own Profile and see other peoples' Profiles as well. This script is useing mysqli that replac..."

__NOTOC__
{{Quicklinks}}

The OpenProfileModule makes it possible to create your own Profile and see other peoples' Profiles as well. 
This script is useing mysqli that replace the deprecated mysql commands with PHP 5.5.0

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OpenProfileModule Configuration Steps ===
The OpenProfileModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OpenProfileModule.

# Upload the profile.sql (below) to your database server
# Upload the profile.php (below) to your web server
# Enable the OpenProfileModule in your OpenSim.ini file

=== STEP 1: profile.sql ===
Save these SQL commands to a profile.sql file on your MySQL database server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `profile_classifieds`
(

`classifieduuid` char(36) NOT NULL,
`creatoruuid` char(36) NOT NULL,

`creationdate` int(20) NOT NULL,
`expirationdate` int(20) NOT NULL,

`category` varchar(20) NOT NULL,
`name` varchar(255) NOT NULL,

`description` text NOT NULL,
`parceluuid` char(36) NOT NULL,

`parentestate` int(11) NOT NULL,
`snapshotuuid` char(36) NOT NULL,

`simname` varchar(255) NOT NULL,
`posglobal` varchar(255) NOT NULL,

`parcelname` varchar(255) NOT NULL,
`classifiedflags` int(8) NOT NULL,

`priceforlisting` int(5) NOT NULL,
PRIMARY KEY (`classifieduuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_notes` (

`useruuid` varchar(36) NOT NULL,

`targetuuid` varchar(36) NOT NULL,

`notes` text NOT NULL,
UNIQUE KEY `useruuid` (`useruuid`,`targetuuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_picks` (

`pickuuid` varchar(36) NOT NULL,
`creatoruuid` varchar(36) NOT NULL,

`toppick` enum('true','false') NOT NULL,
`parceluuid` varchar(36) NOT NULL,

`name` varchar(255) NOT NULL,

`description` text NOT NULL,

`snapshotuuid` varchar(36) NOT NULL,

`user` varchar(255) NOT NULL,

`originalname` varchar(255) NOT NULL,

`simname` varchar(255) NOT NULL,

`posglobal` varchar(255) NOT NULL,

`sortorder` int(2) NOT NULL,

`enabled` enum('true','false') NOT NULL,
PRIMARY KEY (`pickuuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile` (

`useruuid` varchar(36) NOT NULL,

`profilePartner` varchar(36) NOT NULL,

`profileAllowPublish` binary(1) NOT NULL,

`profileMaturePublish` binary(1) NOT NULL,

`profileURL` varchar(255) NOT NULL,

`profileWantToMask` int(3) NOT NULL,

`profileWantToText` text NOT NULL,

`profileSkillsMask` int(3) NOT NULL,

`profileSkillsText` text NOT NULL,

`profileLanguages` text NOT NULL,

`profileImage` varchar(36) NOT NULL,

`profileAboutText` text NOT NULL,

`profileFirstImage` varchar(36) NOT NULL,

`profileFirstText` text NOT NULL,
PRIMARY KEY (`useruuid`)
)
ENGINE=MyISAM DEFAULT CHARSET=latin1;

CREATE TABLE IF NOT EXISTS `profile_settings` (

`useruuid` varchar(36) NOT NULL,

`imviaemail` enum('true','false') NOT NULL,

`visible` enum('true','false') NOT NULL,

`email` varchar(254) NOT NULL,
PRIMARY KEY (`useruuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the profile.sql file to configure your database to hold additional profile information:
<pre>
mysql> source profile.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: profile.php ===

Copy this PHP script to a file called profile.php and edit the following parameters in the script. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, Add the required data between the "" 

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the profile tables are stored
C_DB_USER = database user you are useing for accesing the profile database
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Profile */

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"userprofiles");
define("C_DB_USER" ,"profileuser");
define("C_DB_PASS" ,"#pro4grd#");
define("C_DB_TABLE" ,"offline");

$zeroUUID = "00000000-0000-0000-0000-000000000000";
$xmlrpc_server = xmlrpc_server_create();

/*-------------------------*/
function openDB($dbHost,$dbUser,$dbPassword,$dbName)
{
/*Open database*/
$link = mysqli_connect($dbHost,$dbUser,$dbPassword,$dbName);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

return $link;
}

/*-------------------------*/
function closeDB($link)
{
/*Close database*/
mysqli_close($link);
}

/*-------------------------*/
function avatarclassifiedsrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['uuid'];

$result = mysqli_query($link,"SELECT * FROM profile_classifieds WHERE ".
"creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$data = array();

while (($row = mysqli_fetch_assoc($result)))
{
$data[] = array(
"classifiedid" => $row["classifieduuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Classifieds Update */
function classified_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];

$classifieduuid = $req['classifiedUUID'];
$creator = $req['creatorUUID'];
$category = $req['category'];
$name = $req['name'];
$description = $req['description'];
$parceluuid = $req['parcelUUID'];
$parentestate = $req['parentestate'];
$snapshotuuid = $req['snapshotUUID'];
$simname = $req['sim_name'];
$globalpos = $req['globalpos'];
$parcelname = $req['parcelname'];
$classifiedflag = $req['classifiedFlags'];
$priceforlist = $req['classifiedPrice'];

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_classifieds WHERE ".
"classifieduuid = '". mysqli_real_escape_string($link,$classifieduuid) ."'");

while ($row = mysqli_fetch_row($check))
{
$ready = $row[0];
}

if ($ready == 0)
{
/* Doing some late checking */
/* Should be done by the module but let's see what happens when */
/* I do it here */

if($parcelname == "")
$parcelname = "Unknown";

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

if($classifiedflag == 2)
{
$creationdate = time();
$expirationdate = time() + (7 * 24 * 60 * 60);
}
else
{
$creationdate = time();
$expirationdate = time() + (365 * 24 * 60 * 60);
}

$insertquery = "INSERT INTO profile_classifieds VALUES ".
"('". mysqli_real_escape_string($link,$classifieduuid) ."',".
"'". mysqli_real_escape_string($link,$creator) ."',".
"". mysqli_real_escape_string($link,$creationdate) .",".
"". mysqli_real_escape_string($link,$expirationdate) .",".
"'". mysqli_real_escape_string($link,$category) ."',".
"'". mysqli_real_escape_string($link,$name) ."',".
"'". mysqli_real_escape_string($link,$description) ."',".
"'". mysqli_real_escape_string($link,$parceluuid) ."',".
"". mysqli_real_escape_string($link,$parentestate) .",".
"'". mysqli_real_escape_string($link,$snapshotuuid) ."',".
"'". mysqli_real_escape_string($link,$simname) ."',".
"'". mysqli_real_escape_string($link,$globalpos) ."',".
"'". mysqli_real_escape_string($link,$parcelname) ."',".
"". mysqli_real_escape_string($link,$classifiedflag) .",".
"". mysqli_real_escape_string($link,$priceforlist) .")";

// Create a new record for this classified
$result = mysqli_query($link,$insertquery);
}
else
{

}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Classifieds Delete */
function classified_delete($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
$req = $params[0];

$classifieduuid = $req['classifiedID'];

$result = mysqli_query($link,"DELETE FROM profile_classifieds WHERE ".
"classifieduuid = '".mysqli_real_escape_string($link,$classifieduuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Picks Request */
function avatarpicksrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['uuid'];
$data = array();
$result = mysqli_query($link,"SELECT `pickuuid`,`name` FROM profile_picks WHERE ". "creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

while (($row = mysqli_fetch_assoc($result)))
{
$data[] = array(
"pickid" => $row["pickuuid"],
"name" => $row["name"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Request Picks for User */
function pickinforequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$pick = $req['pick_id'];

$data = array();

$result = mysqli_query($link,"SELECT * FROM profile_picks WHERE ".
"creatoruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"pickuuid = '". mysqli_real_escape_string($link,$pick) ."'");

$row = mysqli_fetch_assoc($result);
if ($row != False)
{
if ($row["description"] == null || $row["description"] == "")
$row["description"] = "No description given";

$data[] = array(
"pickuuid" => $row["pickuuid"],
"creatoruuid" => $row["creatoruuid"],
"toppick" => $row["toppick"],
"parceluuid" => $row["parceluuid"],
"name" => $row["name"],
"description" => $row["description"],
"snapshotuuid" => $row["snapshotuuid"],
"user" => $row["user"],
"originalname" => $row["originalname"],
"simname" => $row["simname"],
"posglobal" => $row["posglobal"],
"sortorder"=> $row["sortorder"],
"enabled" => $row["enabled"]);
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Picks Update */
function picks_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];

$pickuuid = $req['pick_id'];
$creator = $req['creator_id'];
$toppick = $req['top_pick'];
$name = $req['name'];
$description = $req['desc'];
$parceluuid = $req['parcel_uuid'];
$snapshotuuid = $req['snapshot_id'];
$user = $req['user'];
$simname = $req['sim_name'];
$posglobal = $req['pos_global'];
$sortorder = $req['sort_order'];
$enabled = $req['enabled'];

if($parceluuid == "")
$parceluuid = $zeroUUID;

if($description == "")
$description = "No Description";

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_picks WHERE ".
"pickuuid = '". mysqli_real_escape_string($link,$pickuuid) ."'");

$row = mysqli_fetch_row($check);

if ($row[0] == 0)
{
if($user == null || $user == "")
$user = "Unknown";

/* The original parcel name is the same as the name of the */
/* profile pick when a new profile pick is being created. */
$original = $name;

$query = "INSERT INTO profile_picks VALUES ".
"('". mysqli_real_escape_string($link,$pickuuid) ."',".
"'". mysqli_real_escape_string($link,$creator) ."',".
"'". mysqli_real_escape_string($link,$toppick) ."',".
"'". mysqli_real_escape_string($link,$parceluuid) ."',".
"'". mysqli_real_escape_string($link,$name) ."',".
"'". mysqli_real_escape_string($link,$description) ."',".
"'". mysqli_real_escape_string($link,$snapshotuuid) ."',".
"'". mysqli_real_escape_string($link,$user) ."',".
"'". mysqli_real_escape_string($link,$original) ."',".
"'". mysqli_real_escape_string($link,$simname) ."',".
"'". mysqli_real_escape_string($link,$posglobal) ."',".
"'". mysqli_real_escape_string($link,$sortorder) ."',".
"'". mysqli_real_escape_string($link,$enabled) ."')";
}
else
{
$query = "UPDATE profile_picks SET " .
"parceluuid = '". mysqli_real_escape_string($link,$parceluuid) . "', " .
"name = '". mysqli_real_escape_string($link,$name) . "', " .
"description = '". mysqli_real_escape_string($link,$description) . "', " .
"snapshotuuid = '". mysqli_real_escape_string($link,$snapshotuuid) . "' WHERE ".
"pickuuid = '". mysqli_real_escape_string($link,$pickuuid) ."'";
}

$result = mysqli_query($link,$query);
if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Picks Delete */
function picks_delete($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$pickuuid = $req['pick_id'];

$result = mysqli_query($link,"DELETE FROM profile_picks WHERE ".
"pickuuid = '".mysqli_real_escape_string($link,$pickuuid) ."'");

if ($result != False)
$result = True;

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Notes Request */
function avatarnotesrequest($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$targetuuid = $req['uuid'];

$result = mysqli_query($link,"SELECT notes FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");

$row = mysqli_fetch_row($result);
if ($row == False)
$notes = "";
else
$notes = $row[0];

$data[] = array(
"targetid" => $targetuuid,
"notes" => $notes);

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Avatar Notes Update */
function avatar_notes_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$targetuuid = $req['target_id'];
$notes = $req['notes'];

/* Check if we already have this one in the database */
$check = mysqli_query($link,"SELECT COUNT(*) FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");

$row = mysqli_fetch_row($check);

if ($row[0] == 0)
{
/* Create a new record for this avatar note */
$result = mysqli_query($link,"INSERT INTO profile_notes VALUES ".
"('". mysqli_real_escape_string($link,$uuid) ."',".
"'". mysqli_real_escape_string($link,$targetuuid) ."',".
"'". mysqli_real_escape_string($link,$notes) ."')");
}
else if ($notes == "")
{
/* Delete the record for this avatar note */
$result = mysqli_query($link,"DELETE FROM profile_notes WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");
}
else
{
/* Update the existing record */
$result = mysqli_query($link,"UPDATE profile_notes SET ".
"notes = '". mysqli_real_escape_string($link,$notes) ."' WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."' AND ".
"targetuuid = '". mysqli_real_escape_string($link,$targetuuid) ."'");
}

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Profile bits */
function avatar_properties_request($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

global $zeroUUID;
$req = $params[0];
$uuid = $req['avatar_id'];

$result = mysqli_query($link,"SELECT * FROM profile WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");
$row = mysqli_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"ProfileUrl" => $row["profileURL"],
"Image" => $row["profileImage"],
"AboutText" => $row["profileAboutText"],
"FirstLifeImage" => $row["profileFirstImage"],
"FirstLifeAboutText" => $row["profileFirstText"],
"Partner" => $row["profilePartner"],

//Return interest data along with avatar properties
"wantmask" => $row["profileWantToMask"],
"wanttext" => $row["profileWantToText"],
"skillsmask" => $row["profileSkillsMask"],
"skillstext" => $row["profileSkillsText"],
"languages" => $row["profileLanguages"]);
}
else
{
//Insert empty record for avatar.
//FIXME: Should this only be done when asking for ones own profile?
$sql = "INSERT INTO profile VALUES ( ".
"'". mysqli_real_escape_string($link,$uuid) ."', ".
"'$zeroUUID', 0, 0, '', 0, '', 0, '', '', ".
"'$zeroUUID', '', '$zeroUUID', '')";
$result = mysqli_query($link,$sql);

$data[] = array(
"ProfileUrl" => "",
"Image" => $zeroUUID,
"AboutText" => "",
"FirstLifeImage" => $zeroUUID,
"FirstLifeAboutText" => "",
"Partner" => $zeroUUID,

"wantmask" => 0,
"wanttext" => "",
"skillsmask" => 0,
"skillstext" => "",
"languages" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
function avatar_properties_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$profileURL = $req['ProfileUrl'];
$image = $req['Image'];
$abouttext = $req['AboutText'];
$firstlifeimage = $req['FirstLifeImage'];
$firstlifetext = $req['FirstLifeAboutText'];

$result=mysqli_query($link,"UPDATE profile SET ".
"profileURL='". mysqli_real_escape_string($link,$profileURL) ."', ".
"profileImage='". mysqli_real_escape_string($link,$image) ."', ".
"profileAboutText='". mysqli_real_escape_string($link,$abouttext) ."', ".
"profileFirstImage='". mysqli_real_escape_string($link,$firstlifeimage) ."', ".
"profileFirstText='". mysqli_real_escape_string($link,$firstlifetext) ."' ".
"WHERE useruuid='". mysqli_real_escape_string($link,$uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => $result,
'errorMessage' => mysqli_error($link)
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* Profile Interests */
function avatar_interests_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$wanttext = $req['wanttext'];
$wantmask = $req['wantmask'];
$skillstext = $req['skillstext'];
$skillsmask = $req['skillsmask'];
$languages = $req['languages'];

$result = mysqli_query($link,"UPDATE profile SET ".
"profileWantToMask = ". mysqli_real_escape_string($link,$wantmask) .",".
"profileWantToText = '". mysqli_real_escape_string($link,$wanttext) ."',".
"profileSkillsMask = ". mysqli_real_escape_string($link,$skillsmask) .",".
"profileSkillsText = '". mysqli_real_escape_string($link,$skillstext) ."',".
"profileLanguages = '". mysqli_real_escape_string($link,$languages) ."' ".
"WHERE useruuid = '". mysqli_real_escape_string($link,$uuid) ."'"
);

$response_xml = xmlrpc_encode(array(
'success' => True
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
/* User Preferences */
function user_preferences_request($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];

$result = mysqli_query($link,"SELECT imviaemail,visible,email FROM profile_settings WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$row = mysqli_fetch_assoc($result);

if ($row != False)
{
$data[] = array(
"imviaemail" => $row["imviaemail"],
"visible" => $row["visible"],
"email" => $row["email"]);
}
else
{
//Insert empty record for avatar.
//NOTE: The 'false' values here are enums defined in database
$sql = "INSERT INTO profile_settings VALUES ".
"('". mysqli_real_escape_string($link,$uuid) ."', ".
"'false', 'false', '')";
$result = mysqli_query($link,$sql);

$data[] = array(
"imviaemail" => False,
"visible" => False,
"email" => "");
}

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
function user_preferences_update($method_name, $params, $app_data)
{
$link=$link=openDB(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);

$req = $params[0];
$uuid = $req['avatar_id'];
$wantim = $req['imViaEmail'];
$directory = $req['visible'];

$result = mysqli_query($link,"UPDATE profile_settings SET ".
"imviaemail = '".mysqli_real_escape_string($link,$wantim) ."', ".
"visible = '".mysqli_real_escape_string($link,$directory) ."' WHERE ".
"useruuid = '". mysqli_real_escape_string($link,$uuid) ."'");

$response_xml = xmlrpc_encode(array(
'success' => True,
'data' => $data
));

print $response_xml;
closeDB($link);
}

/*-------------------------*/
xmlrpc_server_register_method($xmlrpc_server, "avatarclassifiedsrequest","avatarclassifiedsrequest");
xmlrpc_server_register_method($xmlrpc_server, "classified_update","classified_update");
xmlrpc_server_register_method($xmlrpc_server, "classified_delete","classified_delete");
xmlrpc_server_register_method($xmlrpc_server, "avatarpicksrequest", "avatarpicksrequest");
xmlrpc_server_register_method($xmlrpc_server, "pickinforequest","pickinforequest");
xmlrpc_server_register_method($xmlrpc_server, "picks_update","picks_update");
xmlrpc_server_register_method($xmlrpc_server, "picks_delete","picks_delete");
xmlrpc_server_register_method($xmlrpc_server, "avatarnotesrequest","avatarnotesrequest");
xmlrpc_server_register_method($xmlrpc_server, "avatar_notes_update", "avatar_notes_update");
xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_request","avatar_properties_request");
xmlrpc_server_register_method($xmlrpc_server, "avatar_properties_update","avatar_properties_update");
xmlrpc_server_register_method($xmlrpc_server, "avatar_interests_update","avatar_interests_update");
xmlrpc_server_register_method($xmlrpc_server, "user_preferences_request","user_preferences_request");
xmlrpc_server_register_method($xmlrpc_server, "user_preferences_update","user_preferences_update");

/* Process the request */
$request_xml = $HTTP_RAW_POST_DATA;
xmlrpc_server_call_method($xmlrpc_server, $request_xml, '');
xmlrpc_server_destroy($xmlrpc_server);
?>
</source >

=== STEP 3: OpenProfileModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Profile] block.

An example configuration is shown below:
<source lang="ini">
[Profile]
Module = "OpenProfileModule"
ProfileURL = "http://yourwebserverdomainname/pathto/profile.php"
</source>

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OpenProfileModule ===
Login to your simulator and try to create your profile.

Check the database profile table to verify whether or not profile.php has written a record there.

P.D: OpenProfileModule only works while you are on your home grid, not when you are connected to other grids over hypergrid.

=== Troubleshooting ===
Error shown in Apache error_log:
<pre style="color:red">
PHP Fatal error: Call to undefined function xmlrpc_server_create() in /var/www/html/opensim/profile.php
</pre>

Cause:
<pre>Many Linux distributions may not ship with PHP XML RPC extensions.</pre>

Steps to Fix:
* Fedora 17:
<pre>
# yum install php-xmlrpc
</pre>

Offline Instant Messaging with php Mysqli

2013-03-26T13:46:39Z

Richardus Raymaker: /* STEP 1: offline.sql */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline.

</source >

<source lang="php">
<?php
/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
* @date: 2013-03-26 -> Changed way timestamp get stored in the database, change in table structure.
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"offline");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-26T13:46:17Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline.

</source >

<source lang="php">
<?php
/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
* @date: 2013-03-26 -> Changed way timestamp get stored in the database, change in table structure.
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"offline");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Messaging

2013-03-25T09:57:22Z

Richardus Raymaker:

__NOTOC__
{{Quicklinks}}

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

NOTE: Diva Canto has contributed a new [[Offline Instant Messaging v2]] module in 0.7.6 dev revision r/22086 which does not need an external PHP script.

You can find a newer script thats useing mysqli that replace the deprecated mysql commands with PHP 5.5.0
[http://opensimulator.org/wiki/Offline_Instant_Messaging_with_php_Mysqli here]

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OfflineMessagingModule Configuration Steps ===
The OfflineMessagingModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OfflineMessagingModule.

# Configure the Offline_IM database table in your MySQL using commands in Offline_IM.sql (below)
# Upload the mysql.php (below) into your web server
# Upload the offline.php (below) into your web server
# Enable the OfflineMessagingModule in your OpenSim.ini file

=== STEP 1: Offline_IM.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `Offline_IM` (
`uuid` varchar(36) NOT NULL,
`message` text NOT NULL,
KEY `uuid` (`uuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the Offline_IM.sql file to configure your database to hold offline IMs:
<pre>
mysql> source Offline_IM.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: mysql.php ===
Copy this PHP script to a file called mysql.php and upload the script file to your web server.

No edits of the script should be necessary.

<source lang="php">
<?php
/*
* Copyright (c) 2007, 2008 Contributors, http://opensimulator.org/
* See CONTRIBUTORS for a full list of copyright holders.
*
* See LICENSE for the full licensing terms of this file.
*
*/

// This looks like its lifted from http://www.weberdev.com/get_example-4372.html
// I'd contact the original developer for licensing info, but his website is broken.

class DB
{
var $Host = C_DB_HOST; // Hostname of our MySQL server
var $Database = C_DB_NAME; // Logical database name on that server
var $User = C_DB_USER; // Database user
var $Password = C_DB_PASS; // Database user's password
var $Link_ID = 0; // Result of mysql_connect()
var $Query_ID = 0; // Result of most recent mysql_query()
var $Record = array(); // Current mysql_fetch_array()-result
var $Row; // Current row number
var $Errno = 0; // Error state of query
var $Error = "";

function halt($msg)
{
echo("</TD></TR></TABLE>Database error: $msg \n");
echo("MySQL error: $this->Errno ($this->Error) \n");
die("Session halted.");
}

function connect()
{
if($this->Link_ID == 0)
{
$this->Link_ID = mysql_connect($this->Host, $this->User, $this->Password);
if (!$this->Link_ID)
{
$this->halt("Link_ID == false, connect failed");
}
$SelectResult = mysql_select_db($this->Database, $this->Link_ID);
if(!$SelectResult)
{
$this->Errno = mysql_errno($this->Link_ID);
$this->Error = mysql_error($this->Link_ID);
$this->halt("cannot select database ".$this->Database."");
}
}
}

function escape($String)
{
return mysql_escape_string($String);
}

function query($Query_String)
{
$this->connect();
$this->Query_ID = mysql_query($Query_String,$this->Link_ID);
$this->Row = 0;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
if (!$this->Query_ID)
{
$this->halt("Invalid SQL: ".$Query_String);
}
return $this->Query_ID;
}

function next_record()
{
$this->Record = @mysql_fetch_array($this->Query_ID);
$this->Row += 1;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
$stat = is_array($this->Record);
if (!$stat)
{
@mysql_free_result($this->Query_ID);
$this->Query_ID = 0;
}
return $this->Record;
}

function num_rows()
{
return mysql_num_rows($this->Query_ID);
}

function affected_rows()
{
return mysql_affected_rows($this->Link_ID);
}

function optimize($tbl_name)
{
$this->connect();
$this->Query_ID = @mysql_query("OPTIMIZE TABLE $tbl_name",$this->Link_ID);
}

function clean_results()
{
if($this->Query_ID != 0) mysql_freeresult($this->Query_ID);
}

function close()
{
if($this->Link_ID != 0) mysql_close($this->Link_ID);
}
}
?>
</source>

=== STEP 3: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?php
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

define("C_DB_TYPE","mysql");
define("C_DB_HOST",$dbHost);
define("C_DB_NAME",$dbName);
define("C_DB_USER",$dbUser);
define("C_DB_PASS",$dbPassword);
define("C_OFFLINE_IM_TBL", "Offline_IM");
include("mysql.php");
$DbLink = new DB;
$method = $_SERVER["PATH_INFO"];
if ($method == "/SaveMessage/")
{
$msg = $HTTP_RAW_POST_DATA;
$start = strpos($msg, "?>");
if ($start != -1)
{
$start+=2;
$msg = substr($msg, $start);
$parts = split("[<>]", $msg);
$to_agent = $parts[12];
$DbLink->query("insert into ".C_OFFLINE_IM_TBL." (uuid, message) values ('" .
mysql_escape_string($to_agent) . "', '" .
mysql_escape_string($msg) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}
if ($method == "/RetrieveMessages/")
{
$parms = $HTTP_RAW_POST_DATA;
$parts = split("[<>]", $parms);
$agent_id = $parts[6];
$DbLink->query("select message from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";
while(list($message) = $DbLink->next_record())
{
echo $message;
}
echo "</ArrayOfGridInstantMessage>";
$DbLink->query("delete from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
exit;
}
?>
</source >

=== STEP 4: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Check the database Offline_IM table to verify whether or not offline.php has written a record there.

Next time the person you messaged logs in, they will get the message and the database will be updated.

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Offline Messaging

2013-03-25T09:53:53Z

Richardus Raymaker:

__NOTOC__
{{Quicklinks}}

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

NOTE: Diva Canto has contributed a new [[Offline Instant Messaging v2]] module in 0.7.6 dev revision r/22086 which does not need an external PHP script.

You can find a newer script thats useing mysqli that replace the deprecated mysql commands with PHP 5.5.0 [[help:http://opensimulator.org/wiki/Offline_Instant_Messaging_with_php_Mysqli|here]]

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OfflineMessagingModule Configuration Steps ===
The OfflineMessagingModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OfflineMessagingModule.

# Configure the Offline_IM database table in your MySQL using commands in Offline_IM.sql (below)
# Upload the mysql.php (below) into your web server
# Upload the offline.php (below) into your web server
# Enable the OfflineMessagingModule in your OpenSim.ini file

=== STEP 1: Offline_IM.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `Offline_IM` (
`uuid` varchar(36) NOT NULL,
`message` text NOT NULL,
KEY `uuid` (`uuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the Offline_IM.sql file to configure your database to hold offline IMs:
<pre>
mysql> source Offline_IM.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: mysql.php ===
Copy this PHP script to a file called mysql.php and upload the script file to your web server.

No edits of the script should be necessary.

<source lang="php">
<?php
/*
* Copyright (c) 2007, 2008 Contributors, http://opensimulator.org/
* See CONTRIBUTORS for a full list of copyright holders.
*
* See LICENSE for the full licensing terms of this file.
*
*/

// This looks like its lifted from http://www.weberdev.com/get_example-4372.html
// I'd contact the original developer for licensing info, but his website is broken.

class DB
{
var $Host = C_DB_HOST; // Hostname of our MySQL server
var $Database = C_DB_NAME; // Logical database name on that server
var $User = C_DB_USER; // Database user
var $Password = C_DB_PASS; // Database user's password
var $Link_ID = 0; // Result of mysql_connect()
var $Query_ID = 0; // Result of most recent mysql_query()
var $Record = array(); // Current mysql_fetch_array()-result
var $Row; // Current row number
var $Errno = 0; // Error state of query
var $Error = "";

function halt($msg)
{
echo("</TD></TR></TABLE>Database error: $msg \n");
echo("MySQL error: $this->Errno ($this->Error) \n");
die("Session halted.");
}

function connect()
{
if($this->Link_ID == 0)
{
$this->Link_ID = mysql_connect($this->Host, $this->User, $this->Password);
if (!$this->Link_ID)
{
$this->halt("Link_ID == false, connect failed");
}
$SelectResult = mysql_select_db($this->Database, $this->Link_ID);
if(!$SelectResult)
{
$this->Errno = mysql_errno($this->Link_ID);
$this->Error = mysql_error($this->Link_ID);
$this->halt("cannot select database ".$this->Database."");
}
}
}

function escape($String)
{
return mysql_escape_string($String);
}

function query($Query_String)
{
$this->connect();
$this->Query_ID = mysql_query($Query_String,$this->Link_ID);
$this->Row = 0;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
if (!$this->Query_ID)
{
$this->halt("Invalid SQL: ".$Query_String);
}
return $this->Query_ID;
}

function next_record()
{
$this->Record = @mysql_fetch_array($this->Query_ID);
$this->Row += 1;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
$stat = is_array($this->Record);
if (!$stat)
{
@mysql_free_result($this->Query_ID);
$this->Query_ID = 0;
}
return $this->Record;
}

function num_rows()
{
return mysql_num_rows($this->Query_ID);
}

function affected_rows()
{
return mysql_affected_rows($this->Link_ID);
}

function optimize($tbl_name)
{
$this->connect();
$this->Query_ID = @mysql_query("OPTIMIZE TABLE $tbl_name",$this->Link_ID);
}

function clean_results()
{
if($this->Query_ID != 0) mysql_freeresult($this->Query_ID);
}

function close()
{
if($this->Link_ID != 0) mysql_close($this->Link_ID);
}
}
?>
</source>

=== STEP 3: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?php
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

define("C_DB_TYPE","mysql");
define("C_DB_HOST",$dbHost);
define("C_DB_NAME",$dbName);
define("C_DB_USER",$dbUser);
define("C_DB_PASS",$dbPassword);
define("C_OFFLINE_IM_TBL", "Offline_IM");
include("mysql.php");
$DbLink = new DB;
$method = $_SERVER["PATH_INFO"];
if ($method == "/SaveMessage/")
{
$msg = $HTTP_RAW_POST_DATA;
$start = strpos($msg, "?>");
if ($start != -1)
{
$start+=2;
$msg = substr($msg, $start);
$parts = split("[<>]", $msg);
$to_agent = $parts[12];
$DbLink->query("insert into ".C_OFFLINE_IM_TBL." (uuid, message) values ('" .
mysql_escape_string($to_agent) . "', '" .
mysql_escape_string($msg) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}
if ($method == "/RetrieveMessages/")
{
$parms = $HTTP_RAW_POST_DATA;
$parts = split("[<>]", $parms);
$agent_id = $parts[6];
$DbLink->query("select message from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";
while(list($message) = $DbLink->next_record())
{
echo $message;
}
echo "</ArrayOfGridInstantMessage>";
$DbLink->query("delete from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
exit;
}
?>
</source >

=== STEP 4: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Check the database Offline_IM table to verify whether or not offline.php has written a record there.

Next time the person you messaged logs in, they will get the message and the database will be updated.

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Offline Instant Messaging with php Mysqli

2013-03-24T14:16:36Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline.

</source >

<source lang="php">
<?php
/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"gridservices");
define("C_DB_USER" ,"offline");
define("C_DB_PASS" ,"#off4me#");
define("C_DB_TABLE" ,"offline");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T14:11:23Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php
/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"gridservices");
define("C_DB_USER" ,"offline");
define("C_DB_PASS" ,"#off4me#");
define("C_DB_TABLE" ,"offline");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T14:09:25Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:29:12Z

Richardus Raymaker: /* STEP 1: offline.sql */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:28:16Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:27:26Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters. 
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE 
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:26:44Z

Richardus Raymaker: /* STEP 1: offline.sql */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the query, go to step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters.
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:26:13Z

Richardus Raymaker: /* STEP 1: offline.sql */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server. 
Or copy the sql query to phpmyadmin and after execute the querry goto step 2.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters.
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:25:12Z

Richardus Raymaker: /* STEP 1: offline.sql */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an offline.sql file on your MySQL server.
Or copy the sql query to phpmyadmin.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters.
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:19:58Z

Richardus Raymaker: /* STEP 2: offline.php */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters.
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:18:20Z

Richardus Raymaker: /* Using the OfflineMessageModule */

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== STEP 1: offline.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

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

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the offline.sql file to configure your database to hold offline IMs:
<pre>
mysql> source offline.sql
</pre>

=== STEP 2: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Open the offline.php file to set the following parameters.
C_DB_HOST, C_DB_DATABASE, C_DB_USER, C_DB_PASS, C_DB_TABLE
Add the required data between the ""

<source lang="php">

C_DB_HOST = the hostname of the server thats running mysql
C_DB_DATABASE = is the database where the offline table is stored
C_DB_USER = database user you are useing for accesing the offline table
C_DB_PASS = user passwd that belongs to the use that you set in C_DB_USER
C_DB_TABLE = table name for offline. default it's offline.

</source >

<source lang="php">
<?php

/* Script based on the code you can find at http://opensimulator.org/wiki/Offline_Messaging
* @author: Richardus Raymaker -> http:\\www.simsquaremetaverse.nl
* @date: 2013-03-23
*/

define("C_DB_HOST" ,"localhost");
define("C_DB_DATABASE" ,"");
define("C_DB_USER" ,"");
define("C_DB_PASS" ,"");
define("C_DB_TABLE" ,"");

/*---*/
function SplitIM($httpRaw)
{
$ImHeaderStartFunc = strpos($httpRaw,"?>");
if ($ImHeaderStartFunc!=-1)
{
$ImHeaderStartFunc+=2;
$httpRawFunc = substr($httpRaw,$ImHeaderStartFunc);
$ImPartsFunc = preg_split('[<|>]',$httpRaw);

return $ImPartsFunc;
}
}
/*---*/

/*----------*/
if (isset($_SERVER["PATH_INFO"]))
{
$urlPath = $_SERVER["PATH_INFO"];
$httpRaw = $HTTP_RAW_POST_DATA;

if ($urlPath=="/SaveMessage/")
{
$start=strpos($httpRaw,"?>");
if ($start!=-1)
{
$httpRaw=substr($httpRaw,$start+2);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("SaveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

/*find toAgent UUID*/
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("toAgentID",$ImParts)+1];
$TMStamp=$ImParts[array_search("timestamp",$ImParts)+1];

/* Store messgae in database and inform user the message is saved */
mysqli_query($link,"insert into ".C_DB_TABLE." (PrincipalID, Message, TMStamp) values ('" . mysqli_real_escape_string($link,$toAgentID) . "',
'" . mysqli_real_escape_string($link,$httpRaw). "',
'" . mysqli_real_escape_string($link,$TMStamp) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";

/*Close offline database*/
mysqli_close($link);
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}

if ($urlPath=="/RetrieveMessages/")
{
error_log($httpRaw);
$ImParts = SplitIM($httpRaw);
$toAgentID=$ImParts[array_search("Guid",$ImParts)+1];
error_log($toAgentID);

/*Open offline database*/
$link = mysqli_connect(C_DB_HOST, C_DB_USER, C_DB_PASS, C_DB_DATABASE);
if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') '. mysqli_connect_error()); error_log("RecieveMessage died"); exit; }
mysqli_set_charset($link, "utf8");

$queryresult=mysqli_query($link,"select Message from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "' ORDER BY ID ASC, TMStamp ASC");

/* Send offline IM messgaes to user */
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";

while ($row = mysqli_fetch_array($queryresult, MYSQL_NUM))
{
echo $row[0];
}
echo "</ArrayOfGridInstantMessage>";

/* Delete message after send it to user */
$queryresult=mysqli_query($link,"delete from ".C_DB_TABLE." where PrincipalID='" . mysqli_real_escape_string($link,$toAgentID) . "'");

/*Close offline database*/
mysqli_close($link);

exit;
}
}

?>

?>
</source >

... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 3: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Offline Instant Messaging with php Mysqli

2013-03-24T13:01:40Z

Richardus Raymaker: Created page with "=== Disclaimer === Please note that these are third party modules which you use at your own risk! OpenSimulator takes no responsibility for these modules."

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

Offline Messaging

2013-03-15T20:50:38Z

Richardus Raymaker: /* Using the OfflineMessageModule */

__NOTOC__
{{Quicklinks}}

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

NOTE: Diva Canto has contributed a new [[Offline Instant Messaging v2]] module in 0.7.6 dev revision r/22086 which does not need an external PHP script.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OfflineMessagingModule Configuration Steps ===
The OfflineMessagingModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OfflineMessagingModule.

# Configure the Offline_IM database table in your MySQL using commands in Offline_IM.sql (below)
# Upload the mysql.php (below) into your web server
# Upload the offline.php (below) into your web server
# Enable the OfflineMessagingModule in your OpenSim.ini file

=== STEP 1: Offline_IM.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `Offline_IM` (
`uuid` varchar(36) NOT NULL,
`message` text NOT NULL,
KEY `uuid` (`uuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the Offline_IM.sql file to configure your database to hold offline IMs:
<pre>
mysql> source Offline_IM.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: mysql.php ===
Copy this PHP script to a file called mysql.php and upload the script file to your web server.

No edits of the script should be necessary.

<source lang="php">
<?php
/*
* Copyright (c) 2007, 2008 Contributors, http://opensimulator.org/
* See CONTRIBUTORS for a full list of copyright holders.
*
* See LICENSE for the full licensing terms of this file.
*
*/

// This looks like its lifted from http://www.weberdev.com/get_example-4372.html
// I'd contact the original developer for licensing info, but his website is broken.

class DB
{
var $Host = C_DB_HOST; // Hostname of our MySQL server
var $Database = C_DB_NAME; // Logical database name on that server
var $User = C_DB_USER; // Database user
var $Password = C_DB_PASS; // Database user's password
var $Link_ID = 0; // Result of mysql_connect()
var $Query_ID = 0; // Result of most recent mysql_query()
var $Record = array(); // Current mysql_fetch_array()-result
var $Row; // Current row number
var $Errno = 0; // Error state of query
var $Error = "";

function halt($msg)
{
echo("</TD></TR></TABLE>Database error: $msg \n");
echo("MySQL error: $this->Errno ($this->Error) \n");
die("Session halted.");
}

function connect()
{
if($this->Link_ID == 0)
{
$this->Link_ID = mysql_connect($this->Host, $this->User, $this->Password);
if (!$this->Link_ID)
{
$this->halt("Link_ID == false, connect failed");
}
$SelectResult = mysql_select_db($this->Database, $this->Link_ID);
if(!$SelectResult)
{
$this->Errno = mysql_errno($this->Link_ID);
$this->Error = mysql_error($this->Link_ID);
$this->halt("cannot select database ".$this->Database."");
}
}
}

function escape($String)
{
return mysql_escape_string($String);
}

function query($Query_String)
{
$this->connect();
$this->Query_ID = mysql_query($Query_String,$this->Link_ID);
$this->Row = 0;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
if (!$this->Query_ID)
{
$this->halt("Invalid SQL: ".$Query_String);
}
return $this->Query_ID;
}

function next_record()
{
$this->Record = @mysql_fetch_array($this->Query_ID);
$this->Row += 1;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
$stat = is_array($this->Record);
if (!$stat)
{
@mysql_free_result($this->Query_ID);
$this->Query_ID = 0;
}
return $this->Record;
}

function num_rows()
{
return mysql_num_rows($this->Query_ID);
}

function affected_rows()
{
return mysql_affected_rows($this->Link_ID);
}

function optimize($tbl_name)
{
$this->connect();
$this->Query_ID = @mysql_query("OPTIMIZE TABLE $tbl_name",$this->Link_ID);
}

function clean_results()
{
if($this->Query_ID != 0) mysql_freeresult($this->Query_ID);
}

function close()
{
if($this->Link_ID != 0) mysql_close($this->Link_ID);
}
}
?>
</source>

=== STEP 3: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?php
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

define("C_DB_TYPE","mysql");
define("C_DB_HOST",$dbHost);
define("C_DB_NAME",$dbName);
define("C_DB_USER",$dbUser);
define("C_DB_PASS",$dbPassword);
define("C_OFFLINE_IM_TBL", "Offline_IM");
include("mysql.php");
$DbLink = new DB;
$method = $_SERVER["PATH_INFO"];
if ($method == "/SaveMessage/")
{
$msg = $HTTP_RAW_POST_DATA;
$start = strpos($msg, "?>");
if ($start != -1)
{
$start+=2;
$msg = substr($msg, $start);
$parts = split("[<>]", $msg);
$to_agent = $parts[12];
$DbLink->query("insert into ".C_OFFLINE_IM_TBL." (uuid, message) values ('" .
mysql_escape_string($to_agent) . "', '" .
mysql_escape_string($msg) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}
if ($method == "/RetrieveMessages/")
{
$parms = $HTTP_RAW_POST_DATA;
$parts = split("[<>]", $parms);
$agent_id = $parts[6];
$DbLink->query("select message from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";
while(list($message) = $DbLink->next_record())
{
echo $message;
}
echo "</ArrayOfGridInstantMessage>";
$DbLink->query("delete from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
exit;
}
?>
</source >

=== STEP 4: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

Check the database Offline_IM table to verify whether or not offline.php has written a record there.

Next time the person you messaged logs in, they will get the message and the database will be updated.

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Offline Messaging

2013-03-15T20:49:10Z

Richardus Raymaker: /* Using the OfflineMessageModule */

__NOTOC__
{{Quicklinks}}

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

NOTE: Diva Canto has contributed a new [[Offline Instant Messaging v2]] module in 0.7.6 dev revision r/22086 which does not need an external PHP script.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OfflineMessagingModule Configuration Steps ===
The OfflineMessagingModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OfflineMessagingModule.

# Configure the Offline_IM database table in your MySQL using commands in Offline_IM.sql (below)
# Upload the mysql.php (below) into your web server
# Upload the offline.php (below) into your web server
# Enable the OfflineMessagingModule in your OpenSim.ini file

=== STEP 1: Offline_IM.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `Offline_IM` (
`uuid` varchar(36) NOT NULL,
`message` text NOT NULL,
KEY `uuid` (`uuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the Offline_IM.sql file to configure your database to hold offline IMs:
<pre>
mysql> source Offline_IM.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: mysql.php ===
Copy this PHP script to a file called mysql.php and upload the script file to your web server.

No edits of the script should be necessary.

<source lang="php">
<?php
/*
* Copyright (c) 2007, 2008 Contributors, http://opensimulator.org/
* See CONTRIBUTORS for a full list of copyright holders.
*
* See LICENSE for the full licensing terms of this file.
*
*/

// This looks like its lifted from http://www.weberdev.com/get_example-4372.html
// I'd contact the original developer for licensing info, but his website is broken.

class DB
{
var $Host = C_DB_HOST; // Hostname of our MySQL server
var $Database = C_DB_NAME; // Logical database name on that server
var $User = C_DB_USER; // Database user
var $Password = C_DB_PASS; // Database user's password
var $Link_ID = 0; // Result of mysql_connect()
var $Query_ID = 0; // Result of most recent mysql_query()
var $Record = array(); // Current mysql_fetch_array()-result
var $Row; // Current row number
var $Errno = 0; // Error state of query
var $Error = "";

function halt($msg)
{
echo("</TD></TR></TABLE>Database error: $msg \n");
echo("MySQL error: $this->Errno ($this->Error) \n");
die("Session halted.");
}

function connect()
{
if($this->Link_ID == 0)
{
$this->Link_ID = mysql_connect($this->Host, $this->User, $this->Password);
if (!$this->Link_ID)
{
$this->halt("Link_ID == false, connect failed");
}
$SelectResult = mysql_select_db($this->Database, $this->Link_ID);
if(!$SelectResult)
{
$this->Errno = mysql_errno($this->Link_ID);
$this->Error = mysql_error($this->Link_ID);
$this->halt("cannot select database ".$this->Database."");
}
}
}

function escape($String)
{
return mysql_escape_string($String);
}

function query($Query_String)
{
$this->connect();
$this->Query_ID = mysql_query($Query_String,$this->Link_ID);
$this->Row = 0;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
if (!$this->Query_ID)
{
$this->halt("Invalid SQL: ".$Query_String);
}
return $this->Query_ID;
}

function next_record()
{
$this->Record = @mysql_fetch_array($this->Query_ID);
$this->Row += 1;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
$stat = is_array($this->Record);
if (!$stat)
{
@mysql_free_result($this->Query_ID);
$this->Query_ID = 0;
}
return $this->Record;
}

function num_rows()
{
return mysql_num_rows($this->Query_ID);
}

function affected_rows()
{
return mysql_affected_rows($this->Link_ID);
}

function optimize($tbl_name)
{
$this->connect();
$this->Query_ID = @mysql_query("OPTIMIZE TABLE $tbl_name",$this->Link_ID);
}

function clean_results()
{
if($this->Query_ID != 0) mysql_freeresult($this->Query_ID);
}

function close()
{
if($this->Link_ID != 0) mysql_close($this->Link_ID);
}
}
?>
</source>

=== STEP 3: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?php
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

define("C_DB_TYPE","mysql");
define("C_DB_HOST",$dbHost);
define("C_DB_NAME",$dbName);
define("C_DB_USER",$dbUser);
define("C_DB_PASS",$dbPassword);
define("C_OFFLINE_IM_TBL", "Offline_IM");
include("mysql.php");
$DbLink = new DB;
$method = $_SERVER["PATH_INFO"];
if ($method == "/SaveMessage/")
{
$msg = $HTTP_RAW_POST_DATA;
$start = strpos($msg, "?>");
if ($start != -1)
{
$start+=2;
$msg = substr($msg, $start);
$parts = split("[<>]", $msg);
$to_agent = $parts[12];
$DbLink->query("insert into ".C_OFFLINE_IM_TBL." (uuid, message) values ('" .
mysql_escape_string($to_agent) . "', '" .
mysql_escape_string($msg) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}
if ($method == "/RetrieveMessages/")
{
$parms = $HTTP_RAW_POST_DATA;
$parts = split("[<>]", $parms);
$agent_id = $parts[6];
$DbLink->query("select message from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";
while(list($message) = $DbLink->next_record())
{
echo $message;
}
echo "</ArrayOfGridInstantMessage>";
$DbLink->query("delete from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
exit;
}
?>
</source >

=== STEP 4: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

Check the database Offline_IM table to verify whether or not offline.php has written a record there.

Next time the person you messaged logs in, they will get the message and the database will be updated.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
</source>

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Offline Messaging

2013-03-15T20:48:45Z

Richardus Raymaker: /* Using the OfflineMessageModule */

__NOTOC__
{{Quicklinks}}

Offline Messaging makes it possible to send IM's to people who are not online.

Instead, the messages are saved to a database and delivered the next time the recipient logs in.

NOTE: Diva Canto has contributed a new [[Offline Instant Messaging v2]] module in 0.7.6 dev revision r/22086 which does not need an external PHP script.

=== Disclaimer ===
Please note that these are third party modules which you use at your own risk! 
OpenSimulator takes no responsibility for these modules.

=== OfflineMessagingModule Configuration Steps ===
The OfflineMessagingModule is already compiled and ready for use in current versions of OpenSimulator.

However, you will need to setup the "back-end" database and PHP connector scripts to support the OfflineMessagingModule.

# Configure the Offline_IM database table in your MySQL using commands in Offline_IM.sql (below)
# Upload the mysql.php (below) into your web server
# Upload the offline.php (below) into your web server
# Enable the OfflineMessagingModule in your OpenSim.ini file

=== STEP 1: Offline_IM.sql ===
Save these SQL commands to an Offline_IM.sql file on your MySQL server.

<source lang="sql">

CREATE TABLE IF NOT EXISTS `Offline_IM` (
`uuid` varchar(36) NOT NULL,
`message` text NOT NULL,
KEY `uuid` (`uuid`)
) ENGINE=MyISAM DEFAULT CHARSET=latin1;

</source >

Connect to your MySQL (Linux commands shown):
<pre>
$ mysql --user=$mysqluser --password=$mysqlpassword $databasename
</pre>
Replace $mysqluser, $mysqlpassword, and $databasename with your specific configuration.

At the mysql prompt, source the Offline_IM.sql file to configure your database to hold offline IMs:
<pre>
mysql> source Offline_IM.sql
... ensure no error messages appear here ...
mysql> quit
</pre>

=== STEP 2: mysql.php ===
Copy this PHP script to a file called mysql.php and upload the script file to your web server.

No edits of the script should be necessary.

<source lang="php">
<?php
/*
* Copyright (c) 2007, 2008 Contributors, http://opensimulator.org/
* See CONTRIBUTORS for a full list of copyright holders.
*
* See LICENSE for the full licensing terms of this file.
*
*/

// This looks like its lifted from http://www.weberdev.com/get_example-4372.html
// I'd contact the original developer for licensing info, but his website is broken.

class DB
{
var $Host = C_DB_HOST; // Hostname of our MySQL server
var $Database = C_DB_NAME; // Logical database name on that server
var $User = C_DB_USER; // Database user
var $Password = C_DB_PASS; // Database user's password
var $Link_ID = 0; // Result of mysql_connect()
var $Query_ID = 0; // Result of most recent mysql_query()
var $Record = array(); // Current mysql_fetch_array()-result
var $Row; // Current row number
var $Errno = 0; // Error state of query
var $Error = "";

function halt($msg)
{
echo("</TD></TR></TABLE>Database error: $msg \n");
echo("MySQL error: $this->Errno ($this->Error) \n");
die("Session halted.");
}

function connect()
{
if($this->Link_ID == 0)
{
$this->Link_ID = mysql_connect($this->Host, $this->User, $this->Password);
if (!$this->Link_ID)
{
$this->halt("Link_ID == false, connect failed");
}
$SelectResult = mysql_select_db($this->Database, $this->Link_ID);
if(!$SelectResult)
{
$this->Errno = mysql_errno($this->Link_ID);
$this->Error = mysql_error($this->Link_ID);
$this->halt("cannot select database ".$this->Database."");
}
}
}

function escape($String)
{
return mysql_escape_string($String);
}

function query($Query_String)
{
$this->connect();
$this->Query_ID = mysql_query($Query_String,$this->Link_ID);
$this->Row = 0;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
if (!$this->Query_ID)
{
$this->halt("Invalid SQL: ".$Query_String);
}
return $this->Query_ID;
}

function next_record()
{
$this->Record = @mysql_fetch_array($this->Query_ID);
$this->Row += 1;
$this->Errno = mysql_errno();
$this->Error = mysql_error();
$stat = is_array($this->Record);
if (!$stat)
{
@mysql_free_result($this->Query_ID);
$this->Query_ID = 0;
}
return $this->Record;
}

function num_rows()
{
return mysql_num_rows($this->Query_ID);
}

function affected_rows()
{
return mysql_affected_rows($this->Link_ID);
}

function optimize($tbl_name)
{
$this->connect();
$this->Query_ID = @mysql_query("OPTIMIZE TABLE $tbl_name",$this->Link_ID);
}

function clean_results()
{
if($this->Query_ID != 0) mysql_freeresult($this->Query_ID);
}

function close()
{
if($this->Link_ID != 0) mysql_close($this->Link_ID);
}
}
?>
</source>

=== STEP 3: offline.php ===
Copy this PHP script to a file called offline.php and upload the script file to your web server.

Edit the $dbName, $dbHost, $dbUser, and $dbPassword lines at the top of the script to match your database and server information.

<source lang="php">
<?php
$dbName = "comunity";
$dbHost = "localhost";
$dbUser = "root";
$dbPassword ="";

define("C_DB_TYPE","mysql");
define("C_DB_HOST",$dbHost);
define("C_DB_NAME",$dbName);
define("C_DB_USER",$dbUser);
define("C_DB_PASS",$dbPassword);
define("C_OFFLINE_IM_TBL", "Offline_IM");
include("mysql.php");
$DbLink = new DB;
$method = $_SERVER["PATH_INFO"];
if ($method == "/SaveMessage/")
{
$msg = $HTTP_RAW_POST_DATA;
$start = strpos($msg, "?>");
if ($start != -1)
{
$start+=2;
$msg = substr($msg, $start);
$parts = split("[<>]", $msg);
$to_agent = $parts[12];
$DbLink->query("insert into ".C_OFFLINE_IM_TBL." (uuid, message) values ('" .
mysql_escape_string($to_agent) . "', '" .
mysql_escape_string($msg) . "')");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>true</boolean>";
}
else
{
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><boolean>false</boolean>";
}
exit;
}
if ($method == "/RetrieveMessages/")
{
$parms = $HTTP_RAW_POST_DATA;
$parts = split("[<>]", $parms);
$agent_id = $parts[6];
$DbLink->query("select message from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><ArrayOfGridInstantMessage xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">";
while(list($message) = $DbLink->next_record())
{
echo $message;
}
echo "</ArrayOfGridInstantMessage>";
$DbLink->query("delete from ".C_OFFLINE_IM_TBL." where uuid='" .
mysql_escape_string($agent_id) . "'");
exit;
}
?>
</source >

=== STEP 4: OfflineMessageModule ===
Shutdown your simulator.

Edit the OpenSim.ini [Messaging] block.

An example configuration is shown below:
<source lang="ini">
[Messaging]
; Control which region module is used for instant messaging.
; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
InstantMessageModule = InstantMessageModule
; MessageTransferModule = MessageTransferModule
OfflineMessageModule = OfflineMessageModule
OfflineMessageURL = http://yourserver/offline.php
MuteListModule = MuteListModule
MuteListURL = http://yourserver/mute.php
ForwardOfflineGroupMessages = true
</source>

P.D: The MuteListModule and URL must be uncommented in order for the offline module to work, even if there is no mute.php file in the web folder.

Once the edits are made, save your OpenSim.ini and restart your simulator.

=== Using the OfflineMessageModule ===

Login and try to send a message to an offline person.
You should see the message: "System: User is not logged in. Message saved."

If you see "Message not saved." check your web server error log.

Check the database Offline_IM table to verify whether or not offline.php has written a record there.

Next time the person you messaged logs in, they will get the message and the database will be updated.

If you are using XAMPP or WAMP or other apache based webserver and you get error

messages like, ''File does not exist: /var/www/offline_im/RetrieveMessages/''.

Then you need to enable the ''mod_rewrite.so'' module in apache.

You also need to create .htaccess file that's placed inside the directory where you have also the offline php files.

the .htaccess file would look like this.

<source lang="ini">
RewriteEngine On
RewriteCond %{REQUEST_URI} "!^/index.php$"
RewriteRule "^(.*)$" "index.php" [L]
<source>

=== Testing Notes ===
These steps and configuration tested working on 2013-Jan-13 with:
* OpenSimulator 0.7.5 r21607 from 2013-Jan-09
* Nant 0.90
* Mono 2.10.8
* MySQL 5.5.28
* PHP XMLRPC 5.4.10
* PHP 5.4.1
* Apache 2.2.22
* Linux Kernel 3.6.11
* Fedora Linux 17 (Beefy Miracle)

Setting Up Mega-Regions

2012-06-21T00:30:01Z

Richardus Raymaker: /* Layout Diagram */

{{Quicklinks}}
{{needsexample}}
{{ambox
| type = content
| text = There are still some outstanding issues being addressed by the Dev team. If you wish to incorporate your existing regions into a megaregion, make OARS and do Full Backups of everything on the current regions. Restoring OAR will deposit the restored region on the most South West Corner ONLY. This is being worked out at the time of this writing. (more information needs to be put in this area...) Updated October 26, 2010}}

= Layout Diagram =

Here is a diagram of possible configurations. This is not all inclusive but is a good example of layout for the regions.

'''SPECIAL NOTE''' - Most Viewers still suffer the 4096 Teleport Bug where people cannot teleport more than 4096 regions away. OSGrid is centered @ 10000 10000. Some Viewers, such as MeerKat or Imprudence, have addressed this recently, others will likely follow suit. This bug applies to HyperGrided regions as well as Non-Hypergrid regions.

Do not place Mega regions and normal regions any closer than 2 regions spaces apart, as they WILL interfere with each other.

[[Image:MegaReg Layout.png|center|512x512px|Mega region Layout Example]]

= Steps =

=== Step 0: Back Up Regions ===

If your OpenSimulator instance doesn't have currently any contents, then skip to [[#Step 1: Edit the File "OpenSim.ini"]].

If your regions have existing content, joining them may be dangerous -- you risk losing content. By way of precaution,

# Make a backup of your database. See [[Backups]] for instructions.
# Make an OAR for EACH REGION which you intend integrate into a megaregion. See [[OpenSim Archives]] for instructions.

=== Step 1: Edit the File "OpenSim.ini" ===

Modify your OpenSim.ini. In <nowiki>[Startup]</nowiki> section, change
<source lang="ini">
; CombineContiguousRegions = false
</source>
to
<source lang="ini">
CombineContiguousRegions = true
</source>

=== Step 2: Edit the File "Regions.ini" ===

Edit the file Region.ini which is located in "bin/Regions".

The example provided in [[#Example of Regions.ini File]] below is for a Mega-Region consists of 3x3, 9 simulator. Fill in the correct information in all the required fields. Remember to order your regions from '''South-West to North-East ''' in your Regions.ini.

=== Step 3 : Start OpenSimulator Instance ===

Start Opensimulator. If your regions have no contents, then you already have it! If not,

# You will see a number of error messages -- ignore them.
# Wait for a while before console activity stopping, then type: '''fix-phantoms'''
# Wait before process completing. It can take several minutes for the backup thread to store everything.
# When the console activity stops, type: '''backup''' (This will persist the data into the Database again as a precaution).
# Restart Opensim, and check that all the objects are in their right places.

See Also: [http://www.metaverseink.com/blog/?p=28 Importing OARs into megaregions (Diva's blog post)]

= Example of Regions.ini File =

<source lang="ini">; 9 Simulator 3x3 Mega-Region Example
; Supply a unique UUID for each region
; Unique InternalPort for Each Region
;
;************************************************
[RegionName_SW]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5000,5000
InternalAddress = 0.0.0.0
InternalPort = 9001
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;************************************************
[RegionName_W]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5000,5001
InternalAddress = 0.0.0.0
InternalPort = 9002
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;************************************************
[RegionName_NW]
RegionUUID = 84b41485-6884-412d-b4a2-2f6941559924
Location = 5000,5002
InternalAddress = 0.0.0.0
InternalPort = 9003
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************
[RegionName_S]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5001,5000
InternalAddress = 0.0.0.0
InternalPort = 9004
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************
[RegionName_Centre]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5001,5001
InternalAddress = 0.0.0.0
InternalPort = 9005
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;************************************************
[RegionName_N]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5001,5002
InternalAddress = 0.0.0.0
InternalPort = 9006
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************
;
[RegionName_SE]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5002,5000
InternalAddress = 0.0.0.0
InternalPort = 9007
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************
[RegionName_E]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5002,5001
InternalAddress = 0.0.0.0
InternalPort = 9008
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************
[RegionName_NE]
RegionUUID = 00000000-0000-0000-0000-000000000000
Location = 5002,5002
InternalAddress = 0.0.0.0
InternalPort = 9009
AllowAlternatePorts = False
ExternalHostName = YourIP_DNSname
;
;NonphysicalPrimMax = 0
;PhysicalPrimMax = 0
ClampPrimSize = False
;MaxPrims = 15000
;
;ScopeID = 00000000-0000-0000-0000-000000000000
;
;************************************************</source>

Setting Up Mega-Regions

2012-06-21T00:29:49Z

Richardus Raymaker: /* Layout Diagram */

RemoteAdmin:admin broadcast

2012-05-03T20:58:33Z

Richardus Raymaker: /* C# */

'''admin_broadcast''' remotely allows to broadcast a general alert to all agents in a region

=== Enabling admin_broadcast ===
If not all functions are enabled, use admin_dbroadcast to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_broadcast,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''message ''
| Message to be broadcasted
|
|}

=== Optional Parameters ===
There are no optional parameters

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|}

=== Error messages ===
No error Messages

== Notes ==
* ''accepted'' is an optional returned parameter, probably used prior to ''success''

== Example ==
=== PHP ===
<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_user (multiple parameters)
$parameters = array('message' => 'Welcome in my region');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);
?>
</source>

=== Python ===

<source lang="python">
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
simulatorUrl = "http://127.0.0.1:9000"

# instantiate server object
simulator = xmlrpclib.Server(simulatorUrl)

# invoke admin_alert: requires password and message
simulator.admin_broadcast({'password': 'secret', 'message': 'the answer is 42'})
</source>

=== C# ===

This C# example is made as console project.
you need to use the XMLRPC.DLL that you can find in the opensim packadge.

<source lang="csharp">
using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Text;
using Nwc.XmlRpc;

namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
var ht = new Hashtable();
ht["password"] = "password";
ht["message"] = "Hello World";
var parameters = new List<Hashtable> { ht };
var rpc = new XmlRpcRequest("admin_broadcast", parameters);
rpc.Invoke("http://127.0.0.1:9999");
}
}
}
</source>

[[RemoteAdmin]]
[[RemoteAdmin:Commands]]

RemoteAdmin:admin broadcast

2012-05-03T20:56:02Z

Richardus Raymaker:

'''admin_broadcast''' remotely allows to broadcast a general alert to all agents in a region

=== Enabling admin_broadcast ===
If not all functions are enabled, use admin_dbroadcast to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_broadcast,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''message ''
| Message to be broadcasted
|
|}

=== Optional Parameters ===
There are no optional parameters

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|}

=== Error messages ===
No error Messages

== Notes ==
* ''accepted'' is an optional returned parameter, probably used prior to ''success''

== Example ==
=== PHP ===
<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_user (multiple parameters)
$parameters = array('message' => 'Welcome in my region');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);
?>
</source>

=== Python ===

<source lang="python">
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
simulatorUrl = "http://127.0.0.1:9000"

# instantiate server object
simulator = xmlrpclib.Server(simulatorUrl)

# invoke admin_alert: requires password and message
simulator.admin_broadcast({'password': 'secret', 'message': 'the answer is 42'})
</source>

=== C# ===

This C# example is made with the consoleapplication.
you need to use the XMLRPC.DLL that you can find in the opensim packadge.

<source lang="csharp">
using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Text;
using Nwc.XmlRpc;

namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
var ht = new Hashtable();
ht["password"] = "password";
ht["message"] = "Hello World";
var parameters = new List<Hashtable> { ht };
var rpc = new XmlRpcRequest("admin_broadcast", parameters);
rpc.Invoke("http://127.0.0.1:9999");
}
}
}
</source>

[[RemoteAdmin]]
[[RemoteAdmin:Commands]]