com.hcl.domino.jna.calendaring.JNACalendaring Maven / Gradle / Ivy
/*
* ==========================================================================
* Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
* All rights reserved.
* ==========================================================================
* Licensed under the Apache License, Version 2.0 (the "License"). You may
* not use this file except in compliance with the License. You may obtain a
* copy of the License at .
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
* ==========================================================================
*/
package com.hcl.domino.jna.calendaring;
import java.io.IOException;
import java.lang.ref.ReferenceQueue;
import java.time.temporal.TemporalAccessor;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import com.hcl.domino.DominoException;
import com.hcl.domino.calendar.CalendarActionData;
import com.hcl.domino.calendar.CalendarActionOptions;
import com.hcl.domino.calendar.CalendarDocumentOpen;
import com.hcl.domino.calendar.CalendarProcess;
import com.hcl.domino.calendar.CalendarRangeRepeat;
import com.hcl.domino.calendar.CalendarRead;
import com.hcl.domino.calendar.CalendarReadRange;
import com.hcl.domino.calendar.CalendarWrite;
import com.hcl.domino.calendar.Calendaring;
import com.hcl.domino.commons.gc.APIObjectAllocations;
import com.hcl.domino.commons.gc.IAPIObject;
import com.hcl.domino.commons.gc.IGCDominoClient;
import com.hcl.domino.commons.util.NotesErrorUtils;
import com.hcl.domino.data.Database;
import com.hcl.domino.data.Document;
import com.hcl.domino.data.DominoDateTime;
import com.hcl.domino.exception.IncompatibleImplementationException;
import com.hcl.domino.exception.ObjectDisposedException;
import com.hcl.domino.jna.BaseJNAAPIObject;
import com.hcl.domino.jna.data.JNADatabase;
import com.hcl.domino.jna.data.JNADocument;
import com.hcl.domino.jna.data.JNADominoDateTime;
import com.hcl.domino.jna.internal.DisposableMemory;
import com.hcl.domino.jna.internal.JNANotesConstants;
import com.hcl.domino.jna.internal.Mem;
import com.hcl.domino.jna.internal.Mem.LockedMemory;
import com.hcl.domino.jna.internal.NotesStringUtils;
import com.hcl.domino.jna.internal.capi.NotesCAPI;
import com.hcl.domino.jna.internal.gc.allocations.JNACalendaringAllocations;
import com.hcl.domino.jna.internal.gc.allocations.JNADatabaseAllocations;
import com.hcl.domino.jna.internal.gc.handles.DHANDLE;
import com.hcl.domino.jna.internal.gc.handles.LockUtil;
import com.hcl.domino.jna.internal.structs.NotesCalendarActionDataStruct;
import com.hcl.domino.jna.internal.structs.NotesTimeDateStruct;
import com.hcl.domino.jna.internal.structs.NotesUniversalNoteIdStruct;
import com.hcl.domino.misc.NotesConstants;
import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.ShortByReference;
/**
* Class to access calendaring and scheduling information of Domino
*
* @author Tammo Riedinger
*/
public class JNACalendaring extends BaseJNAAPIObject implements Calendaring {
public JNACalendaring(IAPIObjectparent) {
super(parent);
}
@SuppressWarnings("rawtypes")
@Override
protected JNACalendaringAllocations createAllocations(IGCDominoClient parentDominoClient,
APIObjectAllocations parentAllocations, ReferenceQueue queue) {
return new JNACalendaringAllocations(parentDominoClient, parentAllocations, this, queue);
}
@Override
public String createCalendarEntry(Database dbMail, String iCal, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory icalMem = NotesStringUtils.toLMBCS(iCal, true, false);
int dwFlags = flags==null ? 0 : CalendarWrite.toBitMask(flags);
DHANDLE.ByReference hRetUID = DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalCreateEntry(hDBMail, icalMem, dwFlags, hRetUID, null);
});
NotesErrorUtils.checkResult(result);
if (hRetUID!=null) {
try (LockedMemory m = Mem.OSMemoryLock(hRetUID, true)) {
Pointer retUIDPtr=m.getPointer();
if (retUIDPtr!=null) {
return NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
}
}
return ""; //$NON-NLS-1$
}
@Override
public void updateCalendarEntry(Database dbMail, String iCal, String uid, String recurId, String comments,
Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory icalMem = NotesStringUtils.toLMBCS(iCal, true, false);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
Memory commentsMem = NotesStringUtils.toLMBCS(comments, true);
int dwFlags = flags==null ? 0 : CalendarWrite.toBitMask(flags);
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalUpdateEntry(hDBMail, icalMem, uidMem, recurIdMem, commentsMem, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
}
@Override
public String getUIDfromDocument(Document document) {
return getUIDfromNoteID(document.getParentDatabase(), document.getNoteID());
}
@Override
public String getUIDfromNoteID(Database dbMail, int noteId) throws DominoException {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
try(DisposableMemory retUID = new DisposableMemory(NotesConstants.MAXPATH)) {
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalGetUIDfromNOTEID(hDBMail, noteId, retUID, (short) (NotesConstants.MAXPATH & 0xffff),
null, 0, null);
});
NotesErrorUtils.checkResult(result);
return NotesStringUtils.fromLMBCS(retUID, -1);
}
}
@Override
public String getUIDFromUNID(Database dbMail, String unid) throws DominoException {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesUniversalNoteIdStruct.ByValue unidObj = NotesUniversalNoteIdStruct.ByValue.newInstance();
unidObj.setUnid(unid);
try(DisposableMemory retUID = new DisposableMemory(NotesConstants.MAXPATH)) {
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalGetUIDfromUNID(hDBMail, unidObj, retUID,
(short) (NotesConstants.MAXPATH & 0xffff), null, 0, null);
});
NotesErrorUtils.checkResult(result);
String uid = NotesStringUtils.fromLMBCS(retUID, -1);
return uid;
}
}
@Override
public String getApptUnidFromUID(String uid) {
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
try(DisposableMemory retApptUnidMem = new DisposableMemory(NotesConstants.MAXPATH)) {
short result = NotesCAPI.get().CalGetApptunidFromUID(uidMem, retApptUnidMem, 0, null);
NotesErrorUtils.checkResult(result);
String apptUnid = NotesStringUtils.fromLMBCS(retApptUnidMem, -1);
return apptUnid;
}
}
@Override
public Document openCalendarEntryDocument(Database dbMail, String uid, String recurId,
Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = flags==null ? 0 : CalendarDocumentOpen.toBitMask(flags);
DHANDLE.ByReference rethNote = DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalOpenNoteHandle(hDBMail, uidMem, recurIdMem, rethNote, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
return new JNADocument(toJNADatabase(dbMail), rethNote);
}
@Override
public String readCalendarEntry(Database dbMail, String uid, String recurId, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
DHANDLE.ByReference hRetCalData = DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalReadEntry(hDBMail, uidMem, recurIdMem, hRetCalData, null, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
try (LockedMemory m = Mem.OSMemoryLock(hRetCalData, true)) {
Pointer retUIDPtr=m.getPointer();
if (retUIDPtr!=null) {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, (int)Math.min(Integer.MAX_VALUE, m.getSize()));
}
}
return retIcal;
}
@Override
public void readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, Appendable retICal,
List retUIDs) throws IOException {
readRange(dbMail, start, end, 0, Integer.MAX_VALUE, null, retICal, retUIDs);
}
@Override
public void readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, int skipCount, int maxRead,
Appendable retICal, List retUIDs) throws IOException {
readRange(dbMail, start, end, skipCount, maxRead, null, retICal, retUIDs);
}
@Override
public void readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, int skipCount, int maxRead,
Collection readMask, Appendable retICal, List retUIDs) throws IOException {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesTimeDateStruct.ByValue startStruct = start==null ? null : NotesTimeDateStruct.ByValue.newInstance(JNADominoDateTime.from(start).getInnards());
NotesTimeDateStruct.ByValue endStruct = end==null ? null : NotesTimeDateStruct.ByValue.newInstance(JNADominoDateTime.from(end).getInnards());
int dwReturnMask = CalendarReadRange.toBitMask(readMask);
int dwReturnMaskExt = CalendarReadRange.toBitMask2(readMask);
//variables to collect the whole lookup result
StringBuilder sbIcalAllData = retICal==null ? null : new StringBuilder();
List uidAllData = retUIDs==null ? null : new ArrayList<>();
while (true) {
AtomicInteger currSkipCount = new AtomicInteger(skipCount);
AtomicInteger remainingToRead = new AtomicInteger(maxRead);
short result;
boolean hasMoreToDo;
boolean hasConflict;
//clear current lookup result, while(true) loop may be run multiple times
//if lookup view changes
if (sbIcalAllData!=null) {
sbIcalAllData.setLength(0);
}
if (uidAllData!=null) {
uidAllData.clear();
}
do {
DHANDLE.ByReference hRetCalData = retICal==null ? null : DHANDLE.newInstanceByReference();
DHANDLE.ByReference hRetUIDData = retUIDs==null ? null : DHANDLE.newInstanceByReference();
ShortByReference retCalBufferLength = new ShortByReference();
ShortByReference retSignalFlags = new ShortByReference();
IntByReference retNumEntriesProcessed = new IntByReference();
result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalReadRange(hDBMail, startStruct, endStruct, currSkipCount.get(),
remainingToRead.get(), dwReturnMask, dwReturnMaskExt, null, hRetCalData,
retCalBufferLength, hRetUIDData, retNumEntriesProcessed, retSignalFlags, 0, null);
});
if ((result & NotesConstants.ERR_MASK)==1028) { //no data found
return;
}
NotesErrorUtils.checkResult(result);
int numEntriesProcessed = retNumEntriesProcessed.getValue();
currSkipCount.addAndGet(numEntriesProcessed);
remainingToRead.addAndGet(-1 * numEntriesProcessed);
if (hRetCalData!=null && retICal!=null && sbIcalAllData!=null) {
//decode iCalendar
int iCalBufLength = retCalBufferLength.getValue() & 0xffff;
if (iCalBufLength>0) {
try (LockedMemory m = Mem.OSMemoryLock(hRetCalData, true)) {
Pointer retUIDPtr=m.getPointer();
if (retUIDPtr!=null) {
String currICal = NotesStringUtils.fromLMBCS(retUIDPtr, iCalBufLength);
sbIcalAllData.append(currICal);
}
}
}
}
if (hRetUIDData!=null && retUIDs!=null && uidAllData!=null) {
//decode UID list
try (LockedMemory m = Mem.OSMemoryLock(hRetUIDData, true)) {
Pointer pUIDData=m.getPointer();
if (pUIDData!=null) {
ShortByReference retTextLength = new ShortByReference();
Memory retTextPointer = new Memory(Native.POINTER_SIZE);
int numEntriesAsInt = Short.toUnsignedInt(NotesCAPI.get().ListGetNumEntries(pUIDData, 0));
for (int i=0; i0);
if (!hasConflict) {
//no read conflict in view, we are done
break;
}
else {
//retry the whole lookup
continue;
}
}
//return what we have read
if (retICal!=null && sbIcalAllData!=null) {
retICal.append(sbIcalAllData.toString());
}
if (retUIDs!=null && uidAllData!=null) {
retUIDs.addAll(uidAllData);
}
}
@Override
public String getRecurrenceID(TemporalAccessor td) {
NotesTimeDateStruct.ByValue tdByVal = NotesTimeDateStruct.ByValue.newInstance(JNADominoDateTime.from(td).getInnards());
try(DisposableMemory retRecurId = new DisposableMemory(NotesConstants.MAXPATH)) {
short result = NotesCAPI.get().CalGetRecurrenceID(tdByVal, retRecurId, (short) ((retRecurId.size()-1) & 0xffff));
NotesErrorUtils.checkResult(result);
String recurId = NotesStringUtils.fromLMBCS(retRecurId, -1);
return recurId;
}
}
@Override
public int getUnappliedNotices(Database dbMail, String uid, List retNoteIds, List retUNIDs) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
ShortByReference retNumNotices = new ShortByReference();
DHANDLE.ByReference phRetNOTEIDs = retNoteIds==null ? null : DHANDLE.newInstanceByReference();
DHANDLE.ByReference phRetUNIDs = retUNIDs==null ? null : DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalGetUnappliedNotices(hDBMail, uidMem,
retNumNotices, phRetNOTEIDs, phRetUNIDs, null, 0, null);
});
NotesErrorUtils.checkResult(result);
int numNotices = retNumNotices.getValue() & 0xffff;
if (numNotices>0) {
if (retNoteIds!=null) {
try (LockedMemory m = Mem.OSMemoryLock(phRetNOTEIDs, true)) {
Pointer ptrNoteIds=m.getPointer();
if (ptrNoteIds!=null) {
for (int i=0; i retUntil, List retNoteIds, List retUNIDs) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
NotesTimeDateStruct tdStartStruct = tdStart==null ? null : NotesTimeDateStruct.newInstance(JNADominoDateTime.from(tdStart).getInnards());
NotesTimeDateStruct tdSinceStruct = tdSince==null ? null : NotesTimeDateStruct.newInstance(JNADominoDateTime.from(tdSince).getInnards());
NotesTimeDateStruct retTdUntilStruct = (retUntil==null || retUntil.get()==null) ? null : NotesTimeDateStruct.newInstance();
ShortByReference retNumInvites = new ShortByReference();
DHANDLE.ByReference phRetNOTEIDs = retNoteIds==null ? null : DHANDLE.newInstanceByReference();
DHANDLE.ByReference phRetUNIDs = retUNIDs==null ? null : DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalGetNewInvitations(hDBMail, tdStartStruct,
uidMem, tdSinceStruct,
retTdUntilStruct, retNumInvites, phRetNOTEIDs, phRetUNIDs, null, 0, null);
});
NotesErrorUtils.checkResult(result);
if (retUntil!=null && retUntil.get()!=null) {
retTdUntilStruct.read();
retUntil.set(new JNADominoDateTime(retTdUntilStruct.Innards));
}
int numInvites = retNumInvites.getValue() & 0xffff;
if (numInvites>0) {
if (retNoteIds!=null) {
try (LockedMemory m = Mem.OSMemoryLock(phRetNOTEIDs, true)) {
Pointer ptrNoteIds=m.getPointer();
if (ptrNoteIds!=null) {
for (int i=0; i flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
DHANDLE.ByReference hRetCalData = DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalReadNotice(hDBMail, noteId, hRetCalData, null, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
try (LockedMemory m = Mem.OSMemoryLock(hRetCalData, true)) {
Pointer retUIDPtr=m.getPointer();
if (retUIDPtr!=null) {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
}
return retIcal;
}
@Override
public String readNotice(Database dbMail, String unid, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesUniversalNoteIdStruct.ByValue unidObj = NotesUniversalNoteIdStruct.ByValue.newInstance();
unidObj.setUnid(unid);
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
DHANDLE.ByReference hRetCalData = DHANDLE.newInstanceByReference();
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalReadNoticeUNID(hDBMail, unidObj, hRetCalData, null, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
try (LockedMemory m = Mem.OSMemoryLock(hRetCalData, true)) {
Pointer retUIDPtr=m.getPointer();
if (retUIDPtr!=null) {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
}
return retIcal;
}
@Override
public void entryAction(Database dbMail, String uid, String recurId, Collection action,
CalendarRangeRepeat scope, String comment, CalendarActionData data, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
int dwRange = scope.getValue();
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalEntryAction(hDBMail, uidMem, recurIdMem,
dwAction, dwRange, commentMem, dataStruct, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
}
@Override
public void noticeAction(Database dbMail, int noteId, Collection action, String comment,
CalendarActionData data, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalNoticeAction(hDBMail, noteId, dwAction,
commentMem, dataStruct, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
}
@Override
public void noticeAction(Database dbMail, String unid, Collection action, String comment,
CalendarActionData data, Collection flags) {
checkDisposed();
JNADatabaseAllocations dbAllocations = getMailDBAllocations(dbMail);
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
NotesUniversalNoteIdStruct.ByValue unidObj = NotesUniversalNoteIdStruct.ByValue.newInstance();
unidObj.setUnid(unid);
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
short result = LockUtil.lockHandle(dbAllocations.getDBHandle(),
(hDBMail) -> {
return NotesCAPI.get().CalNoticeActionUNID(hDBMail, unidObj, dwAction,
commentMem, dataStruct, dwFlags, null);
});
NotesErrorUtils.checkResult(result);
}
@Override
public CalendarActionData buildActionData() {
return new JNACalendarActionData();
}
private JNADatabaseAllocations getMailDBAllocations(Database dbMail) throws DominoException {
JNADatabase jnaMailDb = toJNADatabase(dbMail);
if (jnaMailDb.isDisposed()) {
throw new ObjectDisposedException(jnaMailDb);
}
return (JNADatabaseAllocations) jnaMailDb.getAdapter(APIObjectAllocations.class);
}
private JNADatabase toJNADatabase(Database db) throws DominoException {
if (db instanceof JNADatabase) {
return (JNADatabase) db;
}
throw new IncompatibleImplementationException(db, JNADatabase.class);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy