Message.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.mailbox |
 |
 |
Zimbra Collaboration Suite |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| EXITS | Procedure exits | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| CYCLOMATIC | Cyclomatic complexity | |
| SIZE | Size of the file in bytes | |
| OPERANDS | Number of operands | |
| FUNCTIONS | Number of function declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| LOGICAL_LINES | Number of statements | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LINE_COMMENT | Number of line comments | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMMENTS | Comment lines | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| LOOPS | Number of loops | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 ("License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.zimbra.com/license
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: Zimbra Collaboration Suite Server.
*
* The Initial Developer of the Original Code is Zimbra, Inc.
* Portions created by Zimbra are Copyright (C) 2004, 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
/*
* Created on Jun 13, 2004
*/
package com.zimbra.cs.mailbox;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import com.zimbra.cs.account.Account;
import com.zimbra.cs.db.DbMailItem;
import com.zimbra.cs.index.MailboxIndex;
import com.zimbra.cs.mailbox.calendar.*;
import com.zimbra.cs.mailbox.calendar.ZCalendar.ICalTok;
import com.zimbra.cs.mailbox.calendar.ZCalendar.ZVCalendar;
import com.zimbra.cs.mime.ParsedAddress;
import com.zimbra.cs.mime.ParsedMessage;
import com.zimbra.cs.mime.TnefConverter;
import com.zimbra.cs.redolog.op.IndexItem;
import com.zimbra.cs.session.PendingModifications.Change;
import com.zimbra.cs.util.AccountUtil;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.util.ZimbraLog;
import com.zimbra.common.util.Log;
import com.zimbra.common.util.LogFactory;
/**
* @author schemers
*/
public class Message extends MailItem {
static class DraftInfo {
String identityId;
String replyType;
int origId = -1;
public DraftInfo() { }
public DraftInfo(String ident) { identityId = ident; }
public DraftInfo(String rt, int id) { replyType = rt; origId = id; }
public DraftInfo(String rt, int id, String ident) { replyType = rt; origId = id; identityId = ident; }
public DraftInfo(Metadata meta) throws ServiceException {
identityId = meta.get(Metadata.FN_IDENTITY_ID, null);
replyType = meta.get(Metadata.FN_REPLY_TYPE, null);
origId = (int) meta.getLong(Metadata.FN_REPLY_ORIG, -1);
}
}
public static class CalendarItemInfo {
private int mCalendarItemId;
private int mComponentNo;
public CalendarItemInfo(int calItemId, int componentNo) {
mCalendarItemId = calItemId;
mComponentNo = componentNo;
}
public int getCalendarItemId() { return mCalendarItemId; }
public int getComponentNo() { return mComponentNo; }
private static final String FN_CALITEMID = "a";
private static final String FN_COMPNO = "c";
Metadata encodeMetadata() {
Metadata md = new Metadata();
md.put(FN_CALITEMID, mCalendarItemId);
md.put(FN_COMPNO, mComponentNo);
return md;
}
static CalendarItemInfo decodeMetadata(Metadata md) throws ServiceException {
int calItemId = (int) md.getLong(FN_CALITEMID);
int componentNo = (int) md.getLong(FN_COMPNO);
return new CalendarItemInfo(calItemId, componentNo);
}
}
/** Class logger for Message class */
static Log sLog = LogFactory.getLog(Message.class);
private String mSender;
private String mRecipients;
private String mFragment;
private String mRawSubject;
private DraftInfo mDraftInfo;
private ArrayList<CalendarItemInfo> mCalendarItemInfos;
/**
* this one will call back into decodeMetadata() to do our initialization
*
* @param mbox
* @param ud
* @throws ServiceException
*/
Message(Mailbox mbox, UnderlyingData ud) throws ServiceException {
super(mbox, ud);
if (mData.type != TYPE_MESSAGE && mData.type != TYPE_CHAT)
throw new IllegalArgumentException();
if (mData.parentId < 0)
mData.parentId = -mId;
}
/** Returns whether the Message was created as a draft. Note that this
* can only be set when the Message is created; it cannot be altered
* thereafter. */
public boolean isDraft() {
return isTagged(mMailbox.mDraftFlag);
}
/** Returns the <code>To:</code> header of the message, if the message
* was sent by the user. Retuns <code>""</code> otherwise. */
public String getRecipients() {
return (mRecipients == null ? "" : mRecipients);
}
/** Returns the first 100 characters of the message's content. The system
* does its best to remove quoted text, etc. before calculating the
* fragment.
*
* @see com.zimbra.cs.index.Fragment */
public String getFragment() {
return (mFragment == null ? "" : mFragment);
}
/** Returns the normalized subject of the message. This is done by
* taking the <code>Subject:</code> header and removing prefixes (e.g.
* <code>"Re:"</code>) and suffixes (e.g. <code>"(fwd)"</code>) and
* the like.
*
* @see ParsedMessage#normalizeSubject */
public String getNormalizedSubject() {
return super.getSubject();
}
/** Returns the raw subject of the message. This is taken directly from
* the <tt>Subject:</tt> header with no processing. */
@Override
public String getSubject() {
return (mRawSubject == null ? "" : mRawSubject);
}
/** Returns the <tt>From:</tt> header of the message if available;
* if not, returns the <tt>Sender:</tt> header. */
@Override
public String getSender() {
return (mSender == null ? "" : mSender);
}
@Override
public String getSortSubject() {
String subject = getNormalizedSubject();
return subject.toUpperCase().substring(0, Math.min(DbMailItem.MAX_SUBJECT_LENGTH, subject.length()));
}
@Override
public String getSortSender() {
String sender = new ParsedAddress(getSender()).getSortString();
return sender.toUpperCase().substring(0, Math.min(DbMailItem.MAX_SENDER_LENGTH, sender.length()));
}
/** Returns whether the Message was sent by the owner of this mailbox.
* Note that this can only be set when the Message is created; it cannot
* be altered thereafter.*/
public boolean isFromMe() {
return (mData.flags & Flag.BITMASK_FROM_ME) != 0;
}
/** Returns the ID of the {@link Conversation} the Message belongs to.
* If the ID is negative, it refers to a single-message
* {@link VirtualConversation}.*/
public int getConversationId() {
return mData.parentId;
}
/** Returns the ID of the Message that this draft message is in reply to.
*
* @return The ID of the Message that this draft message is in reply to,
* or -1 for Messages that are not drafts or not replies/forwards.
* @see #getDraftReplyType */
public int getDraftOrigId() {
return (mDraftInfo == null ? -1 : mDraftInfo.origId);
}
/** Returns the "reply type" for a draft message.
*
* @return <code>"f"</code> if this draft message is a forward,
* <code>"r"</code> if this draft message is a reply, or
* <code>""</code> for Messages that are not drafts or not
* replies/forwards.
* @see #getDraftOrigId
* @see com.zimbra.cs.service.mail.SendMsg#TYPE_FORWARD
* @see com.zimbra.cs.service.mail.SendMsg#TYPE_REPLY */
public String getDraftReplyType() {
return (mDraftInfo == null || mDraftInfo.replyType == null ? "" : mDraftInfo.replyType);
}
/** Returns the ID of the {@link com.zimbra.cs.account.Identity} that was
* used to compose this draft message.
*
* @return The ID of the Identity used to compose this draft message, or ""
* for Messages that are not drafts or did not specify an identity.
* @see #getDraftReplyType
* @see #getDraftOrigId() */
public String getDraftIdentityId() {
return (mDraftInfo == null || mDraftInfo.identityId == null ? "" : mDraftInfo.identityId);
}
/** Returns whether the Message has a vCal attachment. */
public boolean isInvite() {
return mCalendarItemInfos != null;
}
public Iterator<CalendarItemInfo> getCalendarItemInfoIterator() {
return mCalendarItemInfos.iterator();
}
public CalendarItemInfo getCalendarItemInfo(int componentId) {
if (mCalendarItemInfos != null &&
(componentId < 0 || componentId < mCalendarItemInfos.size()))
return mCalendarItemInfos.get(componentId);
else
return null;
}
/** Returns a JavaMail {@link javax.mail.internet.MimeMessage}
* encapsulating the message content. If possible, TNEF and uuencoded
* attachments are expanded and their components are presented as
* standard MIME attachments. If TNEF or uuencode decoding fails, the
* MimeMessage wraps the raw message content.
*
* @return A MimeMessage wrapping the RFC822 content of the Message.
* @throws ServiceException when errors occur opening, reading,
* uncompressing, or parsing the message file,
* or when the file does not exist.
* @see MailItem#getContentStream()
* @see MailItem#getContent()
* @see TnefConverter
* @see UUEncodeConverter */
public MimeMessage getMimeMessage() throws ServiceException {
return getMimeMessage(true);
}
/** Returns a JavaMail {@link javax.mail.internet.MimeMessage}
* encapsulating the message content. If <tt>runConverters</tt> is
* <tt>true</tt>, TNEF and uuencoded attachments are expanded and their
* components are presented as standard MIME attachments. If
* <tt>runConverters</tt> is <tt>false</tt> or if TNEF or uuencode
* decoding fails, the MimeMessage wraps the raw message content.
*
* @return A MimeMessage wrapping the RFC822 content of the Message.
* @throws ServiceException when errors occur opening, reading,
* uncompressing, or parsing the message file,
* or when the file does not exist.
* @see #getContentStream()
* @see #getContent()
* @see TnefConverter
* @see UUEncodeConverter */
public MimeMessage getMimeMessage(boolean runConverters) throws ServiceException {
return MessageCache.getMimeMessage(this, runConverters);
}
@Override boolean isTaggable() { return true; }
@Override boolean isCopyable() { return true; }
@Override boolean isMovable() { return true; }
@Override boolean isMutable() { return isTagged(mMailbox.mDraftFlag); }
@Override boolean isIndexed() { return true; }
@Override boolean canHaveChildren() { return false; }
@Override boolean canParent(MailItem item) { return false; }
static class MessageCreateFactory {
Message create(Mailbox mbox, UnderlyingData data) throws ServiceException {
return new Message(mbox, data);
}
byte getType() {
return TYPE_MESSAGE;
}
}
static Message create(int id, Folder folder, Conversation conv, ParsedMessage pm,
int msgSize, String digest, short volumeId, boolean unread,
int flags, long tags, DraftInfo dinfo, boolean noICal, ZVCalendar cal)
throws ServiceException {
return createInternal(id, folder, conv, pm, msgSize, digest, volumeId, unread,
flags, tags, dinfo, noICal, cal,new MessageCreateFactory());
}
protected static Message createInternal(int id, Folder folder, Conversation conv, ParsedMessage pm,
int msgSize, String digest, short volumeId, boolean unread,
int flags, long tags, DraftInfo dinfo, boolean noICal, ZVCalendar cal,
MessageCreateFactory fact) throws ServiceException {
if (folder == null || !folder.canContain(TYPE_MESSAGE))
throw MailServiceException.CANNOT_CONTAIN();
if (!folder.canAccess(ACL.RIGHT_INSERT))
throw ServiceException.PERM_DENIED("you do not have the required rights on the folder");
Mailbox mbox = folder.getMailbox();
List<Invite> components = null;
String methodStr = null;
if (cal != null) {
Account acct = mbox.getAccount();
// XXX: shouldn't we just be checking flags for Flag.FLAG_FROM_ME?
// boolean sentByMe = (flags & Flag.FLAG_FROM_ME) != 0;
boolean sentByMe = false;
try {
String pmSender = pm.getSender();
if (pmSender != null && pmSender.length() > 0) {
String sender = new InternetAddress(pmSender).getAddress();
sentByMe = AccountUtil.addressMatchesAccount(acct, sender);
}
} catch (AddressException e) {
throw ServiceException.INVALID_REQUEST("unable to parse invite sender: " + pm.getSender(), e);
}
try {
components = Invite.createFromCalendar(acct, pm.getFragment(), cal, sentByMe, mbox, id);
methodStr = cal.getPropVal(ICalTok.METHOD, ICalTok.PUBLISH.toString());
} catch (Exception e) {
ZimbraLog.calendar.warn("Unable to process iCalendar attachment", e);
}
}
UnderlyingData data = new UnderlyingData();
data.id = id;
data.type = fact.getType();
if (conv != null)
data.parentId = conv.getId();
data.folderId = folder.getId();
data.indexId = id;
data.imapId = id;
data.volumeId = volumeId;
data.date = (int) (pm.getReceivedDate() / 1000);
data.size = msgSize;
data.blobDigest = digest;
data.flags = flags & (Flag.FLAGS_MESSAGE | Flag.FLAGS_GENERIC);
data.tags = tags;
data.sender = pm.getParsedSender().getSortString();
data.subject = pm.getNormalizedSubject();
data.metadata = encodeMetadata(DEFAULT_COLOR, pm, flags, dinfo, null);
data.unreadCount = unread ? 1 : 0;
data.contentChanged(mbox);
DbMailItem.create(mbox, data);
Message msg = fact.create(mbox, data);
// process the components in this invite (must do this last so blob is created, etc)
if (components != null) {
try {
msg.processInvitesAfterCreate(methodStr, folder.getId(), volumeId, !noICal, pm, components);
} catch (Exception e) {
ZimbraLog.calendar.warn("Unable to process iCalendar attachment", e);
}
}
msg.finishCreation(conv);
return msg;
}
/** This has to be done as a separate step, after the MailItem has been
* added, because of foreign key constraints on the CalendarItems table
* @param invites */
private void processInvitesAfterCreate(String method, int folderId, short volumeId, boolean createCalItem, ParsedMessage pm, List<Invite> invites)
throws ServiceException {
// since this is the first time we've seen this Invite Message, we need to process it
// and see if it updates an existing CalendarItem in the database table, or whatever...
boolean updatedMetadata = false;
for (Invite cur : invites) {
boolean calItemIsNew = false;
boolean modifiedCalItem = false;
CalendarItem calItem = mMailbox.getCalendarItemByUid(cur.getUid());
if (createCalItem) {
if (calItem == null) {
// ONLY create a calendar item if this is a REQUEST method...otherwise don't.
if (method.equals(ICalTok.REQUEST.toString())) {
calItem = mMailbox.createCalendarItem(Mailbox.ID_FOLDER_CALENDAR, volumeId, 0, 0, cur.getUid(), pm, cur);
calItemIsNew = true;
} else {
sLog.info("Mailbox " + getMailboxId()+" Message "+getId()+" SKIPPING Invite "+method+" b/c no CalendarItem could be found");
continue; // for now, just ignore this Invitation
}
} else {
// When updating an existing calendar item, ignore the
// passed-in folderId which will usually be Inbox. Leave
// the calendar item in the folder it's currently in.
modifiedCalItem = calItem.processNewInvite(pm, cur, false, calItem.getFolderId(), volumeId);
}
}
if (calItem != null) {
CalendarItemInfo info = new CalendarItemInfo(calItem.getId(), cur.getComponentNum());
if (mCalendarItemInfos == null) {
mCalendarItemInfos = new ArrayList<CalendarItemInfo>();
}
mCalendarItemInfos.add(info);
updatedMetadata = true;
if (calItemIsNew || modifiedCalItem) {
mMailbox.queueForIndexing(calItem, !calItemIsNew, null);
}
}
}
if (updatedMetadata)
saveMetadata();
}
/** Updates the in-memory unread counts for the item. Also updates the
* item's folder, its tag, and its parent. Note that the parent is not
* fetched from the database, so notifications may be off in the case of
* uncached {@link Conversation}s when a {@link Message} changes state.
*
* @param delta The change in unread count for this item. */
@Override
protected void updateUnread(int delta) throws ServiceException {
if (delta == 0 || !trackUnread())
return;
markItemModified(Change.MODIFIED_UNREAD);
// update our unread count (should we check that we don't have too many unread?)
mData.unreadCount += delta;
if (mData.unreadCount < 0)
throw ServiceException.FAILURE("inconsistent state: unread < 0 for " + getClass().getName() + " " + mId, null);
// update the folder's unread count
getFolder().updateUnread(delta);
// update the parent's unread count
MailItem parent = getCachedParent();
if (parent != null)
parent.updateUnread(delta);
// tell the tags about the new unread item
updateTagUnread(delta);
}
/** @perms {@link ACL#RIGHT_INSERT} on the target folder,
* {@link ACL#RIGHT_READ} on the original item */
@Override
MailItem copy(Folder folder, int id, short destVolumeId) throws IOException, ServiceException {
Message copy = (Message) super.copy(folder, id, destVolumeId);
Conversation parent = (Conversation) getParent();
if (parent instanceof VirtualConversation && !isDraft() && inSpam() == folder.inSpam()) {
Conversation conv = mMailbox.createConversation(new Message[] { this, copy }, Mailbox.ID_AUTO_INCREMENT);
DbMailItem.changeOpenTarget(Mailbox.getHash(getNormalizedSubject()), this, conv.getId());
parent.removeChild(this);
}
return copy;
}
@Override
public void reindex(IndexItem redo, boolean deleteFirst, Object indexData) throws ServiceException {
MailboxIndex mi = mMailbox.getMailboxIndex();
if (mi == null)
return;
ParsedMessage pm = (ParsedMessage) indexData;
if (pm == null) {
// force the pm's received-date to be the correct one
pm = new ParsedMessage(getMimeMessage(), getDate(),getMailbox().attachmentsIndexingEnabled());
// because of bug 8263, we sometimes have fragments that are incorrect:
// check them here and correct them if necessary
if (pm.getFragment().compareTo(getFragment()) != 0) {
getMailbox().reanalyze(getId(), getType(), pm);
}
}
mi.indexMessage(mMailbox, redo, deleteFirst, pm, this);
}
public void reanalyze() throws ServiceException {
ParsedMessage pm = new ParsedMessage(getMimeMessage(), getDate(), getMailbox().attachmentsIndexingEnabled());
reanalyze(pm);
}
@Override
void reanalyze(Object data) throws ServiceException {
if (!(data instanceof ParsedMessage))
throw ServiceException.FAILURE("cannot reanalyze non-ParsedMessage object", null);
ParsedMessage pm = (ParsedMessage) data;
int size;
try {
size = pm.getRawSize();
} catch (Exception e) {
throw MailServiceException.MESSAGE_PARSE_ERROR(e);
}
// make sure the SUBJECT is correct
if (!getSubject().equals(pm.getSubject()))
markItemModified(Change.MODIFIED_SUBJECT);
boolean subjectChanged = !getNormalizedSubject().equals(pm.getNormalizedSubject());
mRawSubject = pm.getSubject();
mData.subject = pm.getNormalizedSubject();
// handle the message's PARENT
boolean parentChanged = false;
MailItem parent = getParent();
if (subjectChanged && mData.parentId != -mId) {
mData.parentId = -mId;
parentChanged = true;
}
// make sure the "attachments" FLAG is correct
boolean hadAttachment = (mData.flags & Flag.BITMASK_ATTACHED) != 0;
mData.flags &= ~Flag.BITMASK_ATTACHED;
if (pm.hasAttachments())
mData.flags |= Flag.BITMASK_ATTACHED;
if (hadAttachment != pm.hasAttachments()) {
markItemModified(Change.MODIFIED_FLAGS);
parent.tagChanged(mMailbox.mAttachFlag, pm.hasAttachments());
}
// update the SIZE and METADATA
if (mData.size != size) {
markItemModified(Change.MODIFIED_SIZE);
mMailbox.updateSize(size - mData.size, false);
mData.size = size;
}
String metadata = encodeMetadata(mColor, pm, mData.flags, mDraftInfo, mCalendarItemInfos);
// rewrite the DB row to reflect our new view
saveData(pm.getParsedSender().getSortString(), metadata);
// if the message is part of a real conversation, need to break it out
if (parentChanged)
parent.removeChild(this);
else if (parent instanceof VirtualConversation)
((VirtualConversation) parent).recalculateMetadata(Arrays.asList(new Message[] { this } ));
}
@Override
void detach() throws ServiceException {
MailItem parent = getParent();
if (!(parent instanceof Conversation))
return;
if (parent.getSize() <= 1) {
mMailbox.closeConversation((Conversation) parent, null);
} else {
// remove this message from its (real) conversation
markItemModified(Change.MODIFIED_PARENT);
parent.removeChild(this);
// and place it in a new, non-"opened", virtual conversation
VirtualConversation vconv = new VirtualConversation(mMailbox, this);
mData.parentId = vconv.getId();
DbMailItem.setParent(this, vconv);
}
}
@Override
void delete(DeleteScope scope, boolean writeTombstones) throws ServiceException {
MailItem parent = getParent();
if (parent instanceof Conversation && ((Conversation) parent).getMessageCount() == 1)
parent.delete(DeleteScope.ENTIRE_ITEM, writeTombstones);
else
super.delete(scope, writeTombstones);
}
@Override
void decodeMetadata(Metadata meta) throws ServiceException {
super.decodeMetadata(meta);
mSender = meta.get(Metadata.FN_SENDER, null);
mRecipients = meta.get(Metadata.FN_RECIPIENTS, null);
mFragment = meta.get(Metadata.FN_FRAGMENT, null);
if (meta.containsKey(Metadata.FN_CALITEM_IDS)) {
mCalendarItemInfos = new ArrayList<CalendarItemInfo>();
MetadataList mdList = meta.getList(Metadata.FN_CALITEM_IDS);
for (int i = 0; i < mdList.size(); i++) {
Metadata md = mdList.getMap(i);
mCalendarItemInfos.add(CalendarItemInfo.decodeMetadata(md));
}
}
Metadata draftMeta = meta.getMap(Metadata.FN_DRAFT, true);
if (draftMeta != null)
mDraftInfo = new DraftInfo(draftMeta);
mRawSubject = mData.subject;
String prefix = meta.get(Metadata.FN_PREFIX, null);
if (prefix != null)
mRawSubject = (mData.subject == null ? prefix : prefix + mData.subject);
String rawSubject = meta.get(Metadata.FN_RAW_SUBJ, null);
if (rawSubject != null)
mRawSubject = rawSubject;
}
@Override
Metadata encodeMetadata(Metadata meta) {
return encodeMetadata(meta, mColor, mSender, mRecipients, mFragment, mData.subject, mRawSubject, mDraftInfo, mCalendarItemInfos);
}
private static String encodeMetadata(byte color, ParsedMessage pm, int flags, DraftInfo dinfo, List<CalendarItemInfo> calItemInfos) {
// cache the "To" header only for messages sent by the user
String recipients = ((flags & Flag.BITMASK_FROM_ME) == 0 ? null : pm.getRecipients());
return encodeMetadata(new Metadata(), color, pm.getSender(), recipients, pm.getFragment(), pm.getNormalizedSubject(), pm.getSubject(), dinfo, calItemInfos).toString();
}
static Metadata encodeMetadata(Metadata meta, byte color, String sender, String recipients, String fragment, String subject, String rawSubject, DraftInfo dinfo, List<CalendarItemInfo> calItemInfos) {
// try to figure out a simple way to make the raw subject from the normalized one
String prefix = null;
if (rawSubject == null || rawSubject.equals(subject))
rawSubject = null;
else if (rawSubject.endsWith(subject)) {
prefix = rawSubject.substring(0, rawSubject.length() - subject.length());
rawSubject = null;
}
meta.put(Metadata.FN_SENDER, sender);
meta.put(Metadata.FN_RECIPIENTS, recipients);
meta.put(Metadata.FN_FRAGMENT, fragment);
meta.put(Metadata.FN_PREFIX, prefix);
meta.put(Metadata.FN_RAW_SUBJ, rawSubject);
if (calItemInfos != null) {
MetadataList mdList = new MetadataList();
for (CalendarItemInfo info : calItemInfos)
mdList.add(info.encodeMetadata());
meta.put(Metadata.FN_CALITEM_IDS, mdList);
}
if (dinfo != null) {
Metadata dmeta = new Metadata();
dmeta.put(Metadata.FN_REPLY_ORIG, dinfo.origId);
dmeta.put(Metadata.FN_REPLY_TYPE, dinfo.replyType);
dmeta.put(Metadata.FN_IDENTITY_ID, dinfo.identityId);
meta.put(Metadata.FN_DRAFT, dmeta);
}
return MailItem.encodeMetadata(meta, color);
}
private static final String CN_SENDER = "sender";
private static final String CN_RECIPIENTS = "to";
private static final String CN_FRAGMENT = "fragment";
@Override
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("message: {");
appendCommonMembers(sb);
sb.append(CN_SENDER).append(": ").append(mSender).append(", ");
if (mRecipients != null)
sb.append(CN_RECIPIENTS).append(": ").append(mRecipients).append(", ");
sb.append(CN_FRAGMENT).append(": ").append(mFragment);
sb.append("}");
return sb.toString();
}
}
The table below shows all metrics for Message.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 86.00 | Number of blocks | |
| BLOCK_COMMENT | 27.00 | Number of block comment lines | |
| COMMENTS | 152.00 | Comment lines | |
| COMMENT_DENSITY | 0.41 | Comment density | |
| COMPARISONS | 67.00 | Number of comparison operators | |
| CYCLOMATIC | 124.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 22.00 | Comments in declarations | |
| DOC_COMMENT | 99.00 | Number of javadoc comment lines | |
| ELOC | 374.00 | Effective lines of code | |
| EXEC_COMMENTS | 21.00 | Comments in executable code | |
| EXITS | 119.00 | Procedure exits | |
| FUNCTIONS | 53.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 92.58 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 191.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 25.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 10.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 4.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 12.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 5.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 4.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 6.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 3.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 1.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 1.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 692.00 | Number of lines in the source file | |
| LINE_COMMENT | 26.00 | Number of line comments | |
| LOC | 444.00 | Lines of code | |
| LOGICAL_LINES | 253.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1349.00 | Number of operands | |
| OPERATORS | 2365.00 | Number of operators | |
| PARAMS | 76.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3714.00 | Halstead program length | |
| PROGRAM_VOCAB | 522.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 115.00 | Number of return points from functions | |
| SIZE | 28330.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 459.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 63.00 | Number of unique operators | |
| WHITESPACE | 96.00 | Number of whitespace lines | |