feat: edit lists/items, upload item images + prefs

Author: chenasraf

appinfo/info.xml

@@ -17,7 +17,7 @@ Pantry helps households stay organized in Nextcloud.
 
 All data is scoped to a house; members only see the houses they belong to.
 ]]></description>
-	<version>1.0.0</version>
+	<version>0.0.1</version>
 	<licence>agpl</licence>
 	<author mail="contact@casraf.dev" homepage="https://github.com/chenasraf/nextcloud-pantry">Chen Asraf</author>
 	<namespace>Pantry</namespace>

composer.json

@@ -31,7 +31,8 @@
   },
   "require": {
     "php": "^8.1",
-    "sabre/vobject": "^4.5"
+    "sabre/vobject": "^4.5",
+    "sabre/xml": "^2.1"
   },
   "require-dev": {
     "bamarni/composer-bin-plugin": "^1.8",

composer.lock

@@ -21,6 +21,7 @@
 
 /**
  * @psalm-import-type PantryLastHouse from ResponseDefinitions
+ * @psalm-import-type PantryImageFolder from ResponseDefinitions
  */
 final class PrefsController extends OCSController {
 	use TranslatesDomainExceptions;
@@ -83,6 +84,41 @@ public function setLastHouse(?int $houseId = null): DataResponse {
 		});
 	}
 
+	/**
+	 * Get the user's preferred image upload folder
+	 *
+	 * @return DataResponse<Http::STATUS_OK, PantryImageFolder, array{}>
+	 *
+	 * 200: Folder returned
+	 */
+	#[ApiRoute(verb: 'GET', url: '/api/prefs/image-folder')]
+	#[NoAdminRequired]
+	public function getImageFolder(): DataResponse {
+		return $this->runAction(function (): DataResponse {
+			$uid = $this->requireUid();
+			return new DataResponse(['folder' => $this->prefs->getImageFolder($uid)]);
+		});
+	}
+
+	/**
+	 * Set the user's preferred image upload folder
+	 *
+	 * @param string $folder Absolute path within the user's files.
+	 *
+	 * @return DataResponse<Http::STATUS_OK, PantryImageFolder, array{}>
+	 *
+	 * 200: Folder updated
+	 */
+	#[ApiRoute(verb: 'PUT', url: '/api/prefs/image-folder')]
+	#[NoAdminRequired]
+	public function setImageFolder(string $folder): DataResponse {
+		return $this->runAction(function () use ($folder): DataResponse {
+			$uid = $this->requireUid();
+			$stored = $this->prefs->setImageFolder($uid, $folder);
+			return new DataResponse(['folder' => $stored]);
+		});
+	}
+
 	private function requireUid(): string {
 		$user = $this->userSession->getUser();
 		if ($user === null) {

lib/Controller/PrefsController.php

@@ -12,6 +12,7 @@
 use OCA\Pantry\ResponseDefinitions;
 use OCA\Pantry\Service\CategoryService;
 use OCA\Pantry\Service\HouseAuthService;
+use OCA\Pantry\Service\ImageService;
 use OCA\Pantry\Service\ShoppingListService;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\ApiRoute;
@@ -35,6 +36,7 @@ public function __construct(
 		private ShoppingListService $lists,
 		private CategoryService $categories,
 		private HouseAuthService $auth,
+		private ImageService $images,
 		private IUserSession $userSession,
 	) {
 		parent::__construct($appName, $request);
@@ -248,6 +250,7 @@ public function addItem(
 	 * @param string|null $quantity New quantity (empty string clears).
 	 * @param string|null $rrule New RRULE (empty string clears).
 	 * @param bool|null $repeatFromCompletion New recurrence anchor mode.
+	 * @param int|null $imageFileId File id of attached image (0 or negative clears).
 	 * @param int|null $sortOrder New sort order.
 	 *
 	 * @return DataResponse<Http::STATUS_OK, PantryListItem, array{}>
@@ -265,9 +268,10 @@ public function updateItem(
 		?string $quantity = null,
 		?string $rrule = null,
 		?bool $repeatFromCompletion = null,
+		?int $imageFileId = null,
 		?int $sortOrder = null,
 	): DataResponse {
-		return $this->runAction(function () use ($houseId, $listId, $itemId, $name, $categoryId, $quantity, $rrule, $repeatFromCompletion, $sortOrder): DataResponse {
+		return $this->runAction(function () use ($houseId, $listId, $itemId, $name, $categoryId, $quantity, $rrule, $repeatFromCompletion, $imageFileId, $sortOrder): DataResponse {
 			$this->auth->requireMember($houseId, $this->requireUid());
 			$item = $this->lists->getItem($itemId);
 			$list = $this->lists->getList($item->getListId());
@@ -296,6 +300,9 @@ public function updateItem(
 			if ($repeatFromCompletion !== null) {
 				$patch['repeatFromCompletion'] = $repeatFromCompletion;
 			}
+			if ($imageFileId !== null) {
+				$patch['imageFileId'] = $imageFileId > 0 ? $imageFileId : null;
+			}
 			if ($sortOrder !== null) {
 				$patch['sortOrder'] = $sortOrder;
 			}
@@ -359,6 +366,81 @@ public function deleteItem(int $houseId, int $listId, int $itemId): DataResponse
 		});
 	}
 
+	/**
+	 * Upload an image for an item
+	 *
+	 * Uploads the request body as an image into the user's configured pantry
+	 * image folder and attaches it to the item.
+	 *
+	 * @param int $houseId House id.
+	 * @param int $listId List id.
+	 * @param int $itemId Item id.
+	 *
+	 * @return DataResponse<Http::STATUS_OK, PantryListItem, array{}>
+	 *
+	 * 200: Image uploaded and attached
+	 */
+	#[ApiRoute(verb: 'POST', url: '/api/houses/{houseId}/lists/{listId}/items/{itemId}/image')]
+	#[NoAdminRequired]
+	public function uploadItemImage(int $houseId, int $listId, int $itemId): DataResponse {
+		return $this->runAction(function () use ($houseId, $listId, $itemId): DataResponse {
+			$uid = $this->requireUid();
+			$this->auth->requireMember($houseId, $uid);
+			$item = $this->lists->getItem($itemId);
+			$list = $this->lists->getList($item->getListId());
+			$this->assertListInHouse($list->getHouseId(), $houseId);
+			if ($item->getListId() !== $listId) {
+				throw new NotFoundException('Item does not belong to this list');
+			}
+
+			$data = $this->request->getUploadedFile('image');
+			if ($data === null || !is_array($data) || ($data['error'] ?? UPLOAD_ERR_NO_FILE) !== UPLOAD_ERR_OK) {
+				throw new \InvalidArgumentException('No image uploaded');
+			}
+			$tmp = (string)($data['tmp_name'] ?? '');
+			if ($tmp === '' || !is_uploaded_file($tmp)) {
+				throw new \InvalidArgumentException('Invalid upload');
+			}
+			$bytes = file_get_contents($tmp);
+			if ($bytes === false) {
+				throw new \RuntimeException('Could not read uploaded file');
+			}
+			$original = (string)($data['name'] ?? 'image.jpg');
+			$fileId = $this->images->uploadForUser($uid, $original, $bytes);
+
+			$updated = $this->lists->updateItem($itemId, ['imageFileId' => $fileId]);
+			return new DataResponse($updated->jsonSerialize());
+		});
+	}
+
+	/**
+	 * Clear the image attached to an item
+	 *
+	 * @param int $houseId House id.
+	 * @param int $listId List id.
+	 * @param int $itemId Item id.
+	 *
+	 * @return DataResponse<Http::STATUS_OK, PantryListItem, array{}>
+	 *
+	 * 200: Image cleared
+	 */
+	#[ApiRoute(verb: 'DELETE', url: '/api/houses/{houseId}/lists/{listId}/items/{itemId}/image')]
+	#[NoAdminRequired]
+	public function clearItemImage(int $houseId, int $listId, int $itemId): DataResponse {
+		return $this->runAction(function () use ($houseId, $listId, $itemId): DataResponse {
+			$uid = $this->requireUid();
+			$this->auth->requireMember($houseId, $uid);
+			$item = $this->lists->getItem($itemId);
+			$list = $this->lists->getList($item->getListId());
+			$this->assertListInHouse($list->getHouseId(), $houseId);
+			if ($item->getListId() !== $listId) {
+				throw new NotFoundException('Item does not belong to this list');
+			}
+			$updated = $this->lists->updateItem($itemId, ['imageFileId' => null]);
+			return new DataResponse($updated->jsonSerialize());
+		});
+	}
+
 	private function requireUid(): string {
 		$user = $this->userSession->getUser();
 		if ($user === null) {

lib/Controller/ShoppingListController.php

@@ -30,6 +30,8 @@
  * @method void setRepeatFromCompletion(bool $repeatFromCompletion)
  * @method int|null getNextDueAt()
  * @method void setNextDueAt(?int $nextDueAt)
+ * @method int|null getImageFileId()
+ * @method void setImageFileId(?int $imageFileId)
  * @method int getSortOrder()
  * @method void setSortOrder(int $sortOrder)
  * @method int getCreatedAt()
@@ -48,6 +50,7 @@ class ShoppingListItem extends Entity implements \JsonSerializable {
 	protected ?string $rrule = null;
 	protected bool $repeatFromCompletion = false;
 	protected ?int $nextDueAt = null;
+	protected ?int $imageFileId = null;
 	protected int $sortOrder = 0;
 	protected int $createdAt = 0;
 	protected int $updatedAt = 0;
@@ -59,6 +62,7 @@ public function __construct() {
 		$this->addType('boughtAt', 'integer');
 		$this->addType('repeatFromCompletion', 'boolean');
 		$this->addType('nextDueAt', 'integer');
+		$this->addType('imageFileId', 'integer');
 		$this->addType('sortOrder', 'integer');
 		$this->addType('createdAt', 'integer');
 		$this->addType('updatedAt', 'integer');
@@ -83,6 +87,7 @@ public function jsonSerialize(): array {
 			'rrule' => $this->rrule,
 			'repeatFromCompletion' => $this->repeatFromCompletion,
 			'nextDueAt' => $this->nextDueAt,
+			'imageFileId' => $this->imageFileId,
 			'sortOrder' => $this->sortOrder,
 			'createdAt' => $this->createdAt,
 			'updatedAt' => $this->updatedAt,

lib/Db/ShoppingListItem.php

@@ -211,6 +211,10 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 				'notnull' => false,
 				'length' => 20,
 			]);
+			$table->addColumn('image_file_id', Types::BIGINT, [
+				'notnull' => false,
+				'length' => 20,
+			]);
 			$table->addColumn('sort_order', Types::INTEGER, [
 				'notnull' => true,
 				'default' => 0,
@@ -226,6 +230,16 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 			$table->setPrimaryKey(['id']);
 			$table->addIndex(['list_id'], 'pantry_items_list_idx');
 			$table->addIndex(['category_id'], 'pantry_items_cat_idx');
+		} else {
+			// Idempotent adds for columns introduced after the initial create
+			// (covers early-dev deployments where the table already existed).
+			$table = $schema->getTable($itemsTable);
+			if (!$table->hasColumn('image_file_id')) {
+				$table->addColumn('image_file_id', Types::BIGINT, [
+					'notnull' => false,
+					'length' => 20,
+				]);
+			}
 		}
 
 		return $schema;

lib/Migration/Version1Date20260405000000.php

@@ -49,6 +49,7 @@
  *     rrule: string|null,
  *     repeatFromCompletion: bool,
  *     nextDueAt: int|null,
+ *     imageFileId: int|null,
  *     sortOrder: int,
  *     createdAt: int,
  *     updatedAt: int,
@@ -68,6 +69,8 @@
  * @psalm-type PantrySuccess = array{success: true}
  *
  * @psalm-type PantryLastHouse = array{houseId: int|null}
+ *
+ * @psalm-type PantryImageFolder = array{folder: string}
  */
 class ResponseDefinitions {
 }