Skip to content

SNS: Fix logbook 'title' length overrun #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
berryma4 merged 1 commit into from
Oct 23, 2013
+20 −9
Merged

SNS: Fix logbook 'title' length overrun #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion products/SNS/plugins/org.csstudio.logbook.sns/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: SNS Elog
Bundle-SymbolicName: org.csstudio.logbook.sns;singleton:=true
Bundle-Version: 3.2.0.qualifier
Bundle-Version: 3.2.1.qualifier
Bundle-Activator: org.csstudio.logbook.sns.Activator
Require-Bundle: org.junit4,
org.eclipse.core.runtime,
Expand Down
27 changes: 19 additions & 8 deletions products/SNS/plugins/org.csstudio.logbook.sns/src/org/csstudio/logbook/sns/elog/ELog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ public class ELog implements Closeable
{
final private RDBUtil rdb;

/** Maximum allowed size for text entry */
final private int MAX_TEXT_SIZE;
/** Maximum allowed size for title and text entry */
final private int MAX_TITLE_SIZE, MAX_TEXT_SIZE;

private static final String DEFAULT_BADGE_NUMBER = "999992"; //$NON-NLS-1$
final private String badge_number;
Expand All @@ -58,7 +58,8 @@ public ELog(final String url, final String user, final String password)
{
this.rdb = RDBUtil.connect(url, user, password, false);
badge_number = getBadgeNumber(user);
MAX_TEXT_SIZE = getMaxContentLength();
MAX_TITLE_SIZE = getMaxEntryColumnLength("TITLE");
MAX_TEXT_SIZE = getMaxEntryColumnLength("CONTENT");
// Only initialize logbooks and categories once per JVM
synchronized (ELog.class)
{
Expand Down Expand Up @@ -98,16 +99,17 @@ private String getBadgeNumber(final String user) throws Exception
return DEFAULT_BADGE_NUMBER;
}

/** Query the RDB for the specified Content length.
/** Query the RDB for the max length of an entry's column
* @param column Name of the column (uppercase)
* @throws Exception
* @return Content length specified in the RDB
*/
private int getMaxContentLength() throws Exception
private int getMaxEntryColumnLength(final String column) throws Exception
{
final ResultSet tables = rdb.getConnection().getMetaData()
.getColumns(null, "LOGBOOK", "LOG_ENTRY", "CONTENT");
.getColumns(null, "LOGBOOK", "LOG_ENTRY", column);
if (!tables.next())
throw new Exception("Unable to locate LOGBOOK.LOG_ENTRY.CONTENT");
throw new Exception("Unable to locate LOGBOOK.LOG_ENTRY." + column);
final int max_elog_text = tables.getInt("COLUMN_SIZE");
return max_elog_text;
}
Expand Down Expand Up @@ -331,10 +333,19 @@ private List<ELogCategory> getCategories(final long entry_id) throws Exception
* @throws Exception
* @return Entry ID
*/
public long createEntry(final String logbook, final String title, final String text, final ELogPriority priority) throws Exception
public long createEntry(final String logbook, String title, String text, final ELogPriority priority) throws Exception
{
final long entry_id; // Entry ID from RDB

if (title.length() >= MAX_TITLE_SIZE)
{ // Shorten title.
// If the title and body are actually the same, that's it.
// Otherwise add title overflow to text.
if (! title.equals(text))
text = "..." + title.substring(MAX_TITLE_SIZE-4) + "\n" + text;
title = title.substring(0, MAX_TITLE_SIZE-4) + "...";
}

if (text.length() < MAX_TEXT_SIZE)
{
// Short text goes into entry
Expand Down