Skip to content

Commit ae6aed6

Browse files
NoxwizardNoxwizard
committed
Updates for Crowd 3.3 and phpBB 3.3
1 parent 2d3be33 commit ae6aed6

5 files changed

Lines changed: 249 additions & 114 deletions

File tree

‎README.markdown‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# phpBB Directory Server for Atlassian Crowd
2-
The phpBB Directory Server is in com.phpbb.crowd.phpBBDirectoryServer. It implements com.atlassian.crowd.integration.directory.RemoteDirectory and can easily be configured as a Directory in Crowd. It does not support any write operations.
2+
The phpBB Directory Server is in `com.phpbb.crowd.phpBBDirectoryServer`. It implements `com.atlassian.crowd.integration.directory.RemoteDirectory` and can easily be configured as a Directory in Crowd. It does not support any write operations.
3+
4+
## Requirements
5+
* Crowd: 3.3.3+
6+
* phpBB: 3.3.0+
37

48
## Installing and Configuring the phpBB Directory Server
5-
Install the Atlassian SDK. Using its atlas-package command you can easily build the phpbbauth jar file from the crowd-phpbb-auth directory. Place this jar file into crowd/webapp/WEB-INF/lib. Make sure to export the CROWD_PHPBB_ROOT_URL environment variable, it needs to contain the URL to the root of your phpBB board. Install the phpBB External Authentication API. In Crowd there is a top level Directories tab. Here you can add a new directory. In the "Implementation Class" field you have to fill in "com.phpbb.crowd.phpBBDirectoryServer". You should disable all possible write operations in the Permissions tab - even if you don't, all write operations will throw Exceptions. The directory server also does not support any attributes. So even if they show up in the GUI they will not be saved by phpBB.
9+
Install the Atlassian SDK. Using its `atlas-package` command you can easily build the phpbbauth jar file from the `crowd-phpbb-auth` directory. Place this jar file into `crowd/webapp/WEB-INF/lib`. Make sure to export the `CROWD_PHPBB_ROOT_URL` environment variable, it needs to contain the URL to the root of your phpBB board. Install the phpBB External Authentication API. In Crowd there is a top level Directories tab. Here you can add a new directory. In the "Implementation Class" field you have to fill in "`com.phpbb.crowd.phpBBDirectoryServer`". You should disable all possible write operations in the Permissions tab - even if you don't, all write operations will throw Exceptions. The directory server also does not support any attributes. So even if they show up in the GUI they will not be saved by phpBB.
610

711
# phpBB External Authentication API
8-
The API is rather simple for now. It consists of a single PHP file, to be placed in the phpBB root directory. The file replies to a number of POST requests. You can ask it to authenticate a user, password pair against the selected authentication method. You can query the user and group tables individually or join them to retrieve information about group memberships. The interface needs to be cleaned up after which it will make more sense to document all the functionality.
12+
The API is rather simple for now. It consists of a single PHP file, to be placed in the phpBB root directory. Copy the values from `config.dist.php` into your board's `config.php`. The file replies to a number of POST requests. You can ask it to authenticate a user, password pair against the selected authentication method. You can query the user and group tables individually or join them to retrieve information about group memberships. The interface needs to be cleaned up after which it will make more sense to document all the functionality.

‎crowd-phpbb-directory-server/pom.xml‎

Lines changed: 55 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,87 @@
77
<modelVersion>4.0.0</modelVersion>
88
<groupId>phpbb</groupId>
99
<artifactId>phpbbauth</artifactId>
10-
<version>1.2-SNAPSHOT</version>
10+
<version>1.3-SNAPSHOT</version>
1111

1212
<organization>
1313
<name>phpBB</name>
14-
<url>http://www.phpbb.com/</url>
14+
<url>https://www.phpBB.com/</url>
1515
</organization>
1616

1717
<name>phpbbauth</name>
1818
<description>This is the phpbb:phpbbauth plugin for Atlassian Crowd.</description>
1919
<packaging>jar</packaging>
2020

21+
<dependencyManagement>
22+
<dependencies>
23+
<dependency>
24+
<groupId>com.atlassian.crowd</groupId>
25+
<artifactId>atlassian-crowd</artifactId>
26+
<version>${crowd.version}</version>
27+
<type>pom</type>
28+
<scope>import</scope>
29+
</dependency>
30+
</dependencies>
31+
</dependencyManagement>
32+
2133
<dependencies>
22-
<dependency>
23-
<groupId>junit</groupId>
24-
<artifactId>junit</artifactId>
25-
<version>4.6</version>
26-
<scope>test</scope>
27-
</dependency>
2834
<dependency>
2935
<groupId>com.atlassian.crowd</groupId>
3036
<artifactId>crowd-api</artifactId>
31-
<version>2.4.0</version>
32-
<scope>provided</scope>
33-
</dependency>
34-
<dependency>
35-
<groupId>com.atlassian.crowd</groupId>
36-
<artifactId>crowd-integration-api</artifactId>
37-
<version>2.4.0</version>
38-
<scope>provided</scope>
3937
</dependency>
4038
</dependencies>
4139

4240
<build>
4341
<plugins>
4442
<plugin>
45-
<artifactId>maven-compiler-plugin</artifactId>
43+
<groupId>com.atlassian.maven.plugins</groupId>
44+
<artifactId>crowd-maven-plugin</artifactId>
45+
<version>${amps.version}</version>
46+
<extensions>true</extensions>
4647
<configuration>
47-
<source>1.6</source>
48-
<target>1.6</target>
48+
<productVersion>${crowd.version}</productVersion>
49+
<productDataVersion>${crowd.data.version}</productDataVersion>
50+
<enableQuickReload>true</enableQuickReload>
51+
52+
<!-- See here for an explanation of default instructions: -->
53+
<!-- https://developer.atlassian.com/docs/advanced-topics/configuration-of-instructions-in-atlassian-plugins -->
54+
<instructions>
55+
<Atlassian-Plugin-Key>${atlassian.plugin.key}</Atlassian-Plugin-Key>
56+
57+
<!-- Add package to export here -->
58+
<Export-Package>
59+
com.phpbb.crowd,
60+
</Export-Package>
61+
62+
<Import-Package>
63+
*
64+
</Import-Package>
65+
</instructions>
66+
<compilerArgument>-Xlint:all</compilerArgument>
67+
<showDeprecation>true</showDeprecation>
4968
</configuration>
5069
</plugin>
70+
<!--plugin>
71+
<groupId>org.apache.maven.plugins</groupId>
72+
<artifactId>maven-compiler-plugin</artifactId>
73+
<configuration>
74+
<source>1.8</source>
75+
<target>1.8</target>
76+
<compilerArgument>-Xlint:all</compilerArgument>
77+
</configuration>
78+
</plugin-->
5179
</plugins>
5280
</build>
5381

5482
<properties>
55-
<crowd.version>2.4.0</crowd.version>
56-
<crowd.data.version>2.4.0</crowd.data.version>
83+
<crowd.version>3.3.3</crowd.version>
84+
<crowd.data.version>3.3.3</crowd.data.version>
85+
<amps.version>8.0.0</amps.version>
86+
<!-- This property ensures consistency between the key in atlassian-plugin.xml and the OSGi bundle's key. -->
87+
<atlassian.plugin.key>${project.groupId}.${project.artifactId}</atlassian.plugin.key>
88+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
89+
<maven.compiler.source>1.8</maven.compiler.source>
90+
<maven.compiler.target>1.8</maven.compiler.target>
5791
</properties>
5892

5993
</project>

0 commit comments

Comments
 (0)