com.jalios.jcms.handler

Class EditMemberPhotoHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.EditDataHandler

com.jalios.jcms.handler.EditMemberHandler

com.jalios.jcms.handler.EditMemberPhotoHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class EditMemberPhotoHandler
extends EditMemberHandler

This form handler processes Member photo.

Since:

jcms-9.0.0

Version:

$Revision: 88392 $

Author:

Kevin Bransard

Field Summary

Fields

Modifier and Type	Field and Description
static int	CROP_STEP
protected static java.lang.String	EXTENSION_HTML_PARAM
protected java.lang.String	filename Used to pass the fileDoc filename through different steps.
protected static java.lang.String	FILENAME_HTML_PARAM
protected int	height
protected static java.lang.String	MBRID_HTML_PARAM
protected Member	member
protected boolean	opExisting
static int	UPLOAD_STEP
protected boolean	useCurrentMemberPhoto
protected int	width
protected int	x1
protected int	x2
protected int	y1
protected int	y2

Fields inherited from class com.jalios.jcms.handler.EditMemberHandler

address, admin, country, delegateMemberSet, deleteSet, department, editCatMode, email, firstName, groupRight, groupRightSet, groups, info, isCharterAccepted, isCharterRefused, isEmailVisible, isGroupEditCat, jobTitle, language, ldapSync, locality, login, mobile, name, newPhoto, NOALERTCHANNEL_MARK, notification, notificationFormHandler, opAddItem, opConfirmSignup, opConvertToMember, opDetachFromLDAP, opDisable, opSignup, opUpdateProfile, organization, password0, password1, password2, passwordHasChanged, phone, photo, poBox, postalCode, profileEditor, publishSet, readCategorySet, region, removePhoto, REVISION, rightsProvided, rootSet, salutation, showCharter, signupKey, street, updateSet, usage, useCategorySet, useCatMode, webdavAccess, workingMember

Fields inherited from class com.jalios.jcms.handler.EditDataHandler

extFormHandler, id, isDeleteForced, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
EditMemberPhotoHandler()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canEdit(Member me, Member other, Workspace workspace) Return true if a given member can edit the profile info of a given member.
static void	displayImage(java.io.OutputStream output, java.io.File file) Output the image file that will be cropped
int	getAvailableHeight()
int	getAvailableWidth()
int	getAvailableX1()
int	getAvailableX2()
int	getAvailableY1()
int	getAvailableY2()
java.lang.String	getFilename()
int	getFormStepCount() Retrieve the total number of steps used for edition when invoking this form handler.
java.lang.String	getFormStepHiddenFields()
java.lang.String	getFormStepPrefixProp()
Member	getMember()
static java.io.File	getTempImage(java.lang.String filename)
protected static java.io.File	getUploadDir()
protected boolean	performFinish()
protected boolean	performNext()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setDocuments(java.lang.String[] v) Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.
void	setFilename(java.lang.String filename)
void	setHeight(java.lang.String height)
void	setMbrId(java.lang.String mbrId)
void	setMember(Member member)
void	setOpExisting(java.lang.String opExisting)
void	setUseCurrentMemberPhoto(boolean useCurrentMemberPhoto)
void	setWidth(java.lang.String width)
void	setX1(java.lang.String x1)
void	setX2(java.lang.String x2)
void	setY1(java.lang.String y1)
void	setY2(java.lang.String y2)
boolean	showCancelButton() Check if the "Cancel" button should be displayed in step modal form.
boolean	showFinishButton() Check if the "Finish" button should be displayed in step modal form.
boolean	showPreviousButton() Check if the "Previous" button should be displayed in step modal form.
boolean	useCurrentMemberPhoto()
protected boolean	validateFinish()
protected boolean	validateNext()

Methods inherited from class com.jalios.jcms.handler.EditMemberHandler

alertSignup, buildAlertRuleSet, canDelete, canPublish, canUpdate, getAvailableAddress, getAvailableAdmin, getAvailableAlertRuleSet, getAvailableCountry, getAvailableDelegateMemberSet, getAvailableDepartment, getAvailableEditCatMode, getAvailableEmail, getAvailableEmailVisible, getAvailableFirstName, getAvailableGroups, getAvailableInfo, getAvailableJobTitle, getAvailableLanguage, getAvailableLdapSync, getAvailableLocality, getAvailableLogin, getAvailableMobile, getAvailableName, getAvailableOrganization, getAvailablePhone, getAvailablePoBox, getAvailablePostalCode, getAvailableReadCategorySet, getAvailableRegion, getAvailableSalutation, getAvailableStreet, getAvailableUsage, getAvailableUseCategorySet, getAvailableUseCatMode, getAvailableWebdavAccess, getCategorySet, getDataClass, getGroupRight, getGroups, getPassword0, getPassword1, getPassword2, getProfileEditor, getShowCharter, isCategoryGroupRight, isExpanded, isGroupRight, performConfirmSignup, performConvertToMember, performCreate, performDelete, performDetachFromLDAP, performDisable, performSignup, performUpdate, releaseDBWorkingMember, sendRedirect, setAddress, setAdmin, setAlertChannels, setAlertDomainNames, setAlertLevels, setCanDelete, setCanPublish, setCanUpdate, setCharterAccepted, setCharterRefused, setCids, setCountry, setDelegateMbrIds, setDepartment, setEditCatMode, setEmail, setEmailVisible, setFields, setFirstName, setGids, setGroupRight, setId, setInfo, setJobTitle, setLanguage, setLdapSync, setLocality, setLogin, setMobile, setName, setNotificationFormHandler, setOpAddItem, setOpConfirmSignup, setOpConvertToMember, setOpDetachFromLDAP, setOpDisable, setOpSignup, setOpUpdateProfile, setOrganization, setPassword0, setPassword1, setPassword2, setPhone, setPoBox, setPostalCode, setProfileEditor, setReadcids, setRegion, setRemovePhoto, setSalutation, setSignupKey, setStreet, setUsage, setUseCatMode, setUsecids, setWebdavAccess, validateAddItem, validateCommonCreateSignup, validateCommonUpdate, validateConfirmSignup, validateConvertToMember, validateCreate, validateDelete, validateDetachFromLDAP, validateDisable, validateMember, validateSignup, validateUpdate, validateUpdateProfile

Methods inherited from class com.jalios.jcms.handler.EditDataHandler

afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getEnumLabels, getEnumValues, getExtFormHandler, getId, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performPrevious, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpFinish, setOpNext, setOpPrevious, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validatePrevious, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showNextButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UPLOAD_STEP

public static final int UPLOAD_STEP

See Also:

Constant Field Values

CROP_STEP

public static final int CROP_STEP

See Also:

Constant Field Values

opExisting

protected boolean opExisting

useCurrentMemberPhoto

protected boolean useCurrentMemberPhoto

x1

protected int x1

y1

protected int y1

x2

protected int x2

y2

protected int y2

width

protected int width

height

protected int height

member

protected Member member

FILENAME_HTML_PARAM

protected static final java.lang.String FILENAME_HTML_PARAM

See Also:

Constant Field Values

EXTENSION_HTML_PARAM

protected static final java.lang.String EXTENSION_HTML_PARAM

See Also:

Constant Field Values

MBRID_HTML_PARAM

protected static final java.lang.String MBRID_HTML_PARAM

See Also:

Constant Field Values

filename

protected java.lang.String filename

Used to pass the fileDoc filename through different steps.

Constructor Detail

EditMemberPhotoHandler

public EditMemberPhotoHandler()

Method Detail

useCurrentMemberPhoto

public boolean useCurrentMemberPhoto()

Returns:

true if user has asked to use his existing photo

processAction

public boolean processAction()
                      throws java.io.IOException

Description copied from class: JcmsFormHandler

Method to be implemented to check/validate action to be performed and process them.

Default implementation is to return false. No need to call super method.

This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.

Overrides:

processAction in class EditMemberHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

getFormStepPrefixProp

public java.lang.String getFormStepPrefixProp()

Overrides:

getFormStepPrefixProp in class JcmsFormHandler

Returns:

the prefix prop for the steps

validateNext

protected boolean validateNext()
                        throws java.io.IOException

Overrides:

validateNext in class EditDataHandler

Throws:

java.io.IOException

performNext

protected boolean performNext()
                       throws java.io.IOException

Overrides:

performNext in class EditDataHandler

Throws:

java.io.IOException

getFormStepCount

public int getFormStepCount()

Description copied from class: JcmsFormHandler

Retrieve the total number of steps used for edition when invoking this form handler.

The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.

See jcore/doSteps.jspf for use of this method.

Overrides:

getFormStepCount in class JcmsFormHandler

Returns:

the total number of steps in this formhandler

showCancelButton

public boolean showCancelButton()

Description copied from class: JcmsFormHandler

Check if the "Cancel" button should be displayed in step modal form.

The default implementation of this method is to always return true.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Overrides:

showCancelButton in class JcmsFormHandler

Returns:

true to display the "Cancel" button, false to hide it

showPreviousButton

public boolean showPreviousButton()

Description copied from class: JcmsFormHandler

Check if the "Previous" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by JcmsFormHandler.getFormStep() is higher than 0.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Overrides:

showPreviousButton in class JcmsFormHandler

Returns:

true to display the "Previous" button, false to hide it

showFinishButton

public boolean showFinishButton()

Description copied from class: JcmsFormHandler

Check if the "Finish" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by JcmsFormHandler.getFormStep() is the last one (as compared with JcmsFormHandler.getFormStepCount().
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Overrides:

showFinishButton in class JcmsFormHandler

Returns:

true to display the "Finish" button, false to hide it

validateFinish

protected boolean validateFinish()
                          throws java.io.IOException

Overrides:

validateFinish in class EditDataHandler

Throws:

java.io.IOException

performFinish

protected boolean performFinish()
                         throws java.io.IOException

Overrides:

performFinish in class EditDataHandler

Throws:

java.io.IOException

getFormStepHiddenFields

public java.lang.String getFormStepHiddenFields()

Overrides:

getFormStepHiddenFields in class JcmsFormHandler

getUploadDir

protected static java.io.File getUploadDir()

Returns:

the JCMS temporary directory.

Since:

jcms-9.0.0

setDocuments

public void setDocuments(java.lang.String[] v)

Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.

Parameters:

v - the documents argument from plupload.

Since:

jcms-9

displayImage

public static void displayImage(java.io.OutputStream output,
                java.io.File file)

Output the image file that will be cropped

Parameters:

output - the output

file - the file

getTempImage

public static java.io.File getTempImage(java.lang.String filename)

Parameters:

filename - the filename

Returns:

the temporary image for given member with the given extension

setOpExisting

public void setOpExisting(java.lang.String opExisting)

setUseCurrentMemberPhoto

public void setUseCurrentMemberPhoto(boolean useCurrentMemberPhoto)

getAvailableX1

public int getAvailableX1()

getAvailableY1

public int getAvailableY1()

getAvailableX2

public int getAvailableX2()

getAvailableY2

public int getAvailableY2()

getAvailableWidth

public int getAvailableWidth()

getAvailableHeight

public int getAvailableHeight()

setX1

public void setX1(java.lang.String x1)

setY1

public void setY1(java.lang.String y1)

setX2

public void setX2(java.lang.String x2)

setY2

public void setY2(java.lang.String y2)

setWidth

public void setWidth(java.lang.String width)

setHeight

public void setHeight(java.lang.String height)

getFilename

public java.lang.String getFilename()

setFilename

public void setFilename(java.lang.String filename)

setMbrId

public void setMbrId(java.lang.String mbrId)

setMember

public void setMember(Member member)

getMember

public Member getMember()

Overrides:

getMember in class EditMemberHandler

canEdit

public static boolean canEdit(Member me,
              Member other,
              Workspace workspace)

Return true if a given member can edit the profile info of a given member.

Parameters:

me - the Member who updates the photo

other - the Member who's photo will be updated

workspace - the current Workspace

Returns:

true if a given member can edit the profile info of a given member.