Skip to content

Commit fc61f45

Browse files
romainguinotromainguinot
committed
minor edits to the README
git-svn-id: https://share-extras.googlecode.com/svn/trunk/Sandbox/Audit Dashlet@384 a3f5c567-fd0f-3a89-9b71-a290c5a5f590
0 parents  commit fc61f45

34 files changed

+2091
-0
lines changed

‎COPYING.txt‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎MAINTAINERS.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Romain Guinot
2+
E-mail: [email protected]

‎README.txt‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
Audit Application dashlet for Alfresco Share
2+
============================================
3+
4+
Author: Romain Guinot
5+
6+
This project defines a custom dashlet to display events for a given audit application.
7+
8+
The dashlet will need to have auditing application(s) already configured, and to be useful some events captured.
9+
See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4) on how to define audit applications and some samples.
10+
11+
Installation
12+
------------
13+
14+
The dashlet has been developed to install on top of an existing Alfresco
15+
3.4 installation.
16+
17+
An Ant build script is provided to build a JAR file containing the
18+
custom files, which can then be installed into the 'tomcat/shared/lib' folder
19+
of your Alfresco installation.
20+
21+
To build the JAR file, run the following command from the base project
22+
directory.
23+
24+
ant clean dist-jar
25+
26+
The command should build a JAR file named sample-audit-dashlet.jar
27+
in the 'dist' directory within your project.
28+
29+
To deploy the dashlet files into a local Tomcat instance for testing, you can
30+
use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
31+
property in Ant.
32+
33+
ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
34+
35+
Once you have run this you will need to restart Tomcat so that the classpath
36+
resources in the JAR file are picked up.
37+
38+
As an alternative, you may also copy the exploded files in your classpath, but they must have the classpath tree than the one in the jar.
39+
If using development/debug mode for the web framework, you will not need to restart tomcat, but you may have to clear your
40+
browser's cache.
41+
42+
Using the dashlet
43+
-----------------
44+
45+
Log in to Alfresco Share and navigate to a site or user dashboard. Click the
46+
Customize Dashboard button to edit the contents of the dashboard and drag
47+
the dashlet into one of the columns from the list of dashlets.
48+
49+
* Configuration :
50+
51+
Click Configure to choose an existing audit application. Results will appear as you type and will be matched
52+
against the live list of audit applications as reported by /api/audit/control.
53+
54+
For convenience, application names are prepended with a space. So by typing a leading space in the search box,
55+
you will see the full list of applications in the suggestions. May be useful if you don't know what application name to search for.
56+
57+
If you want you can also select an additional value filter to limit the results.
58+
This server-side filter correspond to the "value" parameter optionally passed to the audit query.
59+
(See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query). This filtering is done server-side
60+
61+
* Search box
62+
63+
The dashlet search box allows more search capabilities than the server side filter, ie :
64+
- field to search on (regex or not), e.g :
65+
id:14
66+
id:1.95$
67+
name:romain
68+
etc...
69+
70+
- negation, e.g
71+
-name:ro
72+
-values:pro
73+
74+
- mutliline matches are enabled, ^ and $ will match beginning of lines for audit values,
75+
useful since there can be more than one line per audit entry
76+
77+
- query can match anywhere in the field by default. queries can be any valid javascript regular expression.
78+
examples : ^romain, values:r.m...$ , id:\d\d8, -time:21 ...
79+
The search box will turn green or red if the regex is valid or invalid, respectively
80+
query can be restricted to the beginning by using ^romain (standard regex) for example.
81+
See https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/regexp for more details.
82+
83+
Each match of the regex in the audit entry will be highlighted. Deferred submatches are also supported for highlighting.
84+
85+
- to search for a colon (:), use the field prefix, eg; field:.+:.+ or values:[^:]+: etc... otherwise the colon will be interpreted
86+
as a field identifier
87+
88+
- multi field search is currently not supported, e.g +id:95 -name:romain. Would have to support ( ) , and/or grouping ,etc ...
89+
90+
This search is done by filtering out undesired entries coming from the datasource prior to browser display.
91+
92+
Changelog
93+
---------
94+
0.3:
95+
- some formatting, commenting, refactored to separate search box UI background coloring from the actual filtering
96+
- highlighting can now be expressed with CSS, rather than hardcoded html bold
97+
- deferred submatches highlighting support
98+
- marker block elision
99+
- results message altered
100+
- search box only shown when an audit application has been configured
101+
- application config will expand immediately on popup if no app is currently configured
102+
- better cross-browser support
103+
- rows per page now configurable in the config dialog
104+
105+
0.22:
106+
- small bug fix : regex remainder fix
107+
- bug fix : generated docdetails and profile links were incorrect when a regex search was already in progress
108+
- lots of other small regex corner cases fixed
109+
- search box background now green or red, depending on whether or not the user search is a valid regex or not, respectively
110+
- ability to list all applications in the config dialog by searching for a leading space, if one does not know what to search for
111+
- renamed some files and web scripts URLs
112+
113+
0.21: small bug fixes : highlighting multiple matches and regression when clearing the search box
114+
115+
0.2 : search box / query filtering
116+
117+
0.1 : inital release
118+

‎build.properties‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
jar.version=0.3
2+
jar.name=sample-audit-dashlet-${jar.version}.jar

0 commit comments

Comments
 (0)