implement Milestone 17: Contacts interface with read/write permissions
This commit is contained in:
@@ -794,7 +794,9 @@ TEST(BluetoothInterface, RequiresUserConsent);
|
||||
|
||||
---
|
||||
|
||||
## Milestone 17: Virtual Hardware - Contacts
|
||||
## Milestone 17: Virtual Hardware - Contacts ✅
|
||||
|
||||
**Status**: Complete
|
||||
|
||||
**Goal**: Contact access with granular permissions.
|
||||
**Estimated Files**: 1 new file
|
||||
|
||||
472
SANDBOX_MILESTONE_17.md
Normal file
472
SANDBOX_MILESTONE_17.md
Normal file
@@ -0,0 +1,472 @@
|
||||
# Milestone 17: Virtual Hardware - Contacts
|
||||
|
||||
**Status**: Complete
|
||||
**Goal**: Contact access with granular read/write permissions.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This milestone implements secure Contacts access for Lua apps:
|
||||
- Separate permissions: `contacts.read` and `contacts.write`
|
||||
- Limited contact fields: name, phone, email (no raw account data)
|
||||
- Query with search/pagination support
|
||||
- Mock mode for desktop testing
|
||||
- Maximum 100 results per query
|
||||
|
||||
### Key Deliverables
|
||||
|
||||
1. **ContactsInterface class** - Contact query and management
|
||||
2. **Contact struct** - Limited contact fields (privacy-preserving)
|
||||
3. **Lua contacts API** - `contacts.query()`, `contacts.add()`, `contacts.update()`, `contacts.delete()`
|
||||
4. **Privacy protection** - Limited fields, permission enforcement
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
src/main/cpp/sandbox/
|
||||
├── contacts_interface.h # NEW - Contacts API header
|
||||
└── contacts_interface.cpp # NEW - Contacts implementation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### 1. ContactsInterface Class
|
||||
|
||||
```cpp
|
||||
// contacts_interface.h
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <optional>
|
||||
#include <functional>
|
||||
#include <mutex>
|
||||
#include <unordered_map>
|
||||
|
||||
struct lua_State;
|
||||
|
||||
namespace mosis {
|
||||
|
||||
struct Contact {
|
||||
int id = 0; // Internal ID
|
||||
std::string name; // Display name
|
||||
std::string phone; // Primary phone number
|
||||
std::string email; // Primary email
|
||||
};
|
||||
|
||||
struct QueryOptions {
|
||||
std::string search; // Search string (matches name, phone, email)
|
||||
int limit = 50; // Max results (capped at 100)
|
||||
int offset = 0; // Pagination offset
|
||||
};
|
||||
|
||||
enum class ContactsError {
|
||||
None,
|
||||
PermissionDenied,
|
||||
NotFound,
|
||||
InvalidData,
|
||||
LimitExceeded
|
||||
};
|
||||
|
||||
class ContactsInterface {
|
||||
public:
|
||||
ContactsInterface(const std::string& app_id);
|
||||
~ContactsInterface();
|
||||
|
||||
// Permission checks
|
||||
bool HasReadPermission() const { return m_has_read_permission; }
|
||||
void SetReadPermission(bool granted) { m_has_read_permission = granted; }
|
||||
|
||||
bool HasWritePermission() const { return m_has_write_permission; }
|
||||
void SetWritePermission(bool granted) { m_has_write_permission = granted; }
|
||||
|
||||
// Query contacts (requires read permission)
|
||||
std::vector<Contact> Query(const QueryOptions& options, std::string& error);
|
||||
|
||||
// Get single contact by ID (requires read permission)
|
||||
std::optional<Contact> GetById(int id, std::string& error);
|
||||
|
||||
// Add contact (requires write permission)
|
||||
int Add(const Contact& contact, std::string& error);
|
||||
|
||||
// Update contact (requires write permission)
|
||||
bool Update(const Contact& contact, std::string& error);
|
||||
|
||||
// Delete contact (requires write permission)
|
||||
bool Delete(int id, std::string& error);
|
||||
|
||||
// Get total contact count (requires read permission)
|
||||
int GetCount(std::string& error);
|
||||
|
||||
// For testing
|
||||
void SetMockMode(bool enabled) { m_mock_mode = enabled; }
|
||||
bool IsMockMode() const { return m_mock_mode; }
|
||||
|
||||
// Mock mode: set contacts directly
|
||||
void SetMockContacts(const std::vector<Contact>& contacts);
|
||||
|
||||
// Clear all mock contacts
|
||||
void ClearMockContacts();
|
||||
|
||||
private:
|
||||
std::string m_app_id;
|
||||
bool m_mock_mode = true;
|
||||
bool m_has_read_permission = false;
|
||||
bool m_has_write_permission = false;
|
||||
std::vector<Contact> m_mock_contacts;
|
||||
int m_next_id = 1;
|
||||
mutable std::mutex m_mutex;
|
||||
|
||||
static constexpr int MAX_RESULTS = 100;
|
||||
|
||||
bool MatchesSearch(const Contact& contact, const std::string& search) const;
|
||||
};
|
||||
|
||||
// Register contacts.* APIs as globals
|
||||
void RegisterContactsAPI(lua_State* L, ContactsInterface* contacts);
|
||||
|
||||
} // namespace mosis
|
||||
```
|
||||
|
||||
### 2. Permission Requirements
|
||||
|
||||
| Action | Permission Required |
|
||||
|--------|---------------------|
|
||||
| Query contacts | `contacts.read` |
|
||||
| Get contact by ID | `contacts.read` |
|
||||
| Get contact count | `contacts.read` |
|
||||
| Add contact | `contacts.write` |
|
||||
| Update contact | `contacts.write` |
|
||||
| Delete contact | `contacts.write` |
|
||||
|
||||
### 3. Privacy Protection
|
||||
|
||||
Contact fields exposed:
|
||||
- `id` - Internal identifier
|
||||
- `name` - Display name
|
||||
- `phone` - Primary phone number
|
||||
- `email` - Primary email address
|
||||
|
||||
NOT exposed:
|
||||
- Account type/name (Google, Exchange, etc.)
|
||||
- Contact photo
|
||||
- Multiple phone numbers/emails
|
||||
- Address, notes, organization
|
||||
- Social profiles
|
||||
- Custom fields
|
||||
- Sync metadata
|
||||
|
||||
### 4. Lua API
|
||||
|
||||
```lua
|
||||
-- Query contacts (requires contacts.read)
|
||||
local results = contacts.query({
|
||||
search = "John", -- optional: search name/phone/email
|
||||
limit = 20, -- optional: max results (default 50, max 100)
|
||||
offset = 0 -- optional: pagination offset
|
||||
})
|
||||
for _, c in ipairs(results) do
|
||||
print(c.id, c.name, c.phone, c.email)
|
||||
end
|
||||
|
||||
-- Get by ID (requires contacts.read)
|
||||
local contact = contacts.getById(123)
|
||||
if contact then
|
||||
print(contact.name)
|
||||
end
|
||||
|
||||
-- Get total count (requires contacts.read)
|
||||
local count = contacts.getCount()
|
||||
|
||||
-- Add contact (requires contacts.write)
|
||||
local newId = contacts.add({
|
||||
name = "John Doe",
|
||||
phone = "555-1234",
|
||||
email = "john@example.com"
|
||||
})
|
||||
|
||||
-- Update contact (requires contacts.write)
|
||||
local success = contacts.update({
|
||||
id = 123,
|
||||
name = "John Smith",
|
||||
phone = "555-5678",
|
||||
email = "john.smith@example.com"
|
||||
})
|
||||
|
||||
-- Delete contact (requires contacts.write)
|
||||
local success = contacts.delete(123)
|
||||
```
|
||||
|
||||
### 5. Error Handling
|
||||
|
||||
```lua
|
||||
-- Errors are raised via Lua errors
|
||||
-- Use pcall for safe error handling
|
||||
local ok, result = pcall(function()
|
||||
return contacts.query({search = "test"})
|
||||
end)
|
||||
if not ok then
|
||||
print("Error:", result) -- e.g., "permission denied: contacts.read required"
|
||||
end
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Test Cases
|
||||
|
||||
### Test 1: Query Requires Read Permission
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsRequiresReadPermission(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
// No permission granted
|
||||
|
||||
std::string err;
|
||||
auto results = contacts.Query({}, err);
|
||||
|
||||
EXPECT_TRUE(results.empty());
|
||||
EXPECT_TRUE(err.find("permission") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 2: Add Requires Write Permission
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsRequiresWritePermission(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true); // Read OK, but not write
|
||||
|
||||
std::string err;
|
||||
mosis::Contact contact{"John Doe", "555-1234", "john@test.com"};
|
||||
int id = contacts.Add(contact, err);
|
||||
|
||||
EXPECT_TRUE(id == 0); // Failed
|
||||
EXPECT_TRUE(err.find("permission") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 3: Query Returns Matching Contacts
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsQueryWorks(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
|
||||
// Set mock contacts
|
||||
std::vector<mosis::Contact> mockContacts = {
|
||||
{1, "John Doe", "555-1234", "john@test.com"},
|
||||
{2, "Jane Doe", "555-5678", "jane@test.com"},
|
||||
{3, "Bob Smith", "555-9999", "bob@test.com"}
|
||||
};
|
||||
contacts.SetMockContacts(mockContacts);
|
||||
|
||||
std::string err;
|
||||
auto results = contacts.Query({.search = "Doe"}, err);
|
||||
|
||||
EXPECT_TRUE(err.empty());
|
||||
EXPECT_TRUE(results.size() == 2); // John and Jane
|
||||
EXPECT_TRUE(results[0].name == "John Doe" || results[0].name == "Jane Doe");
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 4: Query Respects Limit
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsQueryLimit(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
|
||||
// Set 50 mock contacts
|
||||
std::vector<mosis::Contact> mockContacts;
|
||||
for (int i = 0; i < 50; i++) {
|
||||
mockContacts.push_back({i + 1, "Contact " + std::to_string(i), "555-" + std::to_string(i), ""});
|
||||
}
|
||||
contacts.SetMockContacts(mockContacts);
|
||||
|
||||
std::string err;
|
||||
|
||||
// Query with limit
|
||||
auto results = contacts.Query({.limit = 10}, err);
|
||||
EXPECT_TRUE(results.size() == 10);
|
||||
|
||||
// Query with excessive limit (capped at MAX_RESULTS)
|
||||
results = contacts.Query({.limit = 200}, err);
|
||||
EXPECT_TRUE(results.size() == 50); // All contacts (< MAX_RESULTS)
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 5: Add/Update/Delete Works
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsCRUD(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
contacts.SetWritePermission(true);
|
||||
|
||||
std::string err;
|
||||
|
||||
// Add
|
||||
mosis::Contact newContact{0, "Test User", "555-1111", "test@test.com"};
|
||||
int id = contacts.Add(newContact, err);
|
||||
EXPECT_TRUE(id > 0);
|
||||
EXPECT_TRUE(err.empty());
|
||||
|
||||
// Read back
|
||||
auto contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(contact.has_value());
|
||||
EXPECT_TRUE(contact->name == "Test User");
|
||||
|
||||
// Update
|
||||
contact->name = "Updated User";
|
||||
contact->phone = "555-2222";
|
||||
bool updated = contacts.Update(*contact, err);
|
||||
EXPECT_TRUE(updated);
|
||||
|
||||
// Verify update
|
||||
contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(contact->name == "Updated User");
|
||||
EXPECT_TRUE(contact->phone == "555-2222");
|
||||
|
||||
// Delete
|
||||
bool deleted = contacts.Delete(id, err);
|
||||
EXPECT_TRUE(deleted);
|
||||
|
||||
// Verify deleted
|
||||
contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(!contact.has_value());
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 6: Delete Nonexistent Fails
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsDeleteNotFound(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetWritePermission(true);
|
||||
|
||||
std::string err;
|
||||
bool deleted = contacts.Delete(99999, err);
|
||||
|
||||
EXPECT_TRUE(!deleted);
|
||||
EXPECT_TRUE(err.find("not found") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
### Test 7: Lua Integration
|
||||
|
||||
```cpp
|
||||
bool Test_ContactsLuaIntegration(std::string& error_msg) {
|
||||
SandboxContext ctx = TestContext();
|
||||
LuaSandbox sandbox(ctx);
|
||||
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
mosis::RegisterContactsAPI(sandbox.GetState(), &contacts);
|
||||
|
||||
std::string script = R"lua(
|
||||
-- Test that contacts global exists
|
||||
if not contacts then
|
||||
error("contacts global not found")
|
||||
end
|
||||
if not contacts.query then
|
||||
error("contacts.query not found")
|
||||
end
|
||||
if not contacts.getById then
|
||||
error("contacts.getById not found")
|
||||
end
|
||||
if not contacts.getCount then
|
||||
error("contacts.getCount not found")
|
||||
end
|
||||
if not contacts.add then
|
||||
error("contacts.add not found")
|
||||
end
|
||||
if not contacts.update then
|
||||
error("contacts.update not found")
|
||||
end
|
||||
if not contacts.delete then
|
||||
error("contacts.delete not found")
|
||||
end
|
||||
)lua";
|
||||
|
||||
bool ok = sandbox.LoadString(script, "contacts_test");
|
||||
if (!ok) {
|
||||
error_msg = "Lua test failed: " + sandbox.GetLastError();
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
All tests must pass:
|
||||
|
||||
- [x] `Test_ContactsRequiresReadPermission` - Read permission required for query
|
||||
- [x] `Test_ContactsRequiresWritePermission` - Write permission required for add
|
||||
- [x] `Test_ContactsQueryWorks` - Query returns matching contacts
|
||||
- [x] `Test_ContactsQueryLimit` - Query respects limit/pagination
|
||||
- [x] `Test_ContactsCRUD` - Add/update/delete works
|
||||
- [x] `Test_ContactsDeleteNotFound` - Delete nonexistent contact fails gracefully
|
||||
- [x] `Test_ContactsLuaIntegration` - Lua API works
|
||||
|
||||
---
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Milestone 1 (LuaSandbox)
|
||||
- Milestone 2 (PermissionGate)
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
### Desktop vs Android Implementation
|
||||
|
||||
For desktop testing, ContactsInterface operates in mock mode:
|
||||
- Stores contacts in memory
|
||||
- Full CRUD support for testing
|
||||
- Search matches name, phone, or email
|
||||
|
||||
On Android, the real implementation would:
|
||||
1. Use ContentResolver to query ContactsContract
|
||||
2. Handle READ_CONTACTS and WRITE_CONTACTS permissions
|
||||
3. Use proper contact lookup/insert/update/delete URIs
|
||||
|
||||
### Security Considerations
|
||||
|
||||
1. **Separate permissions**: Read and write are independent
|
||||
2. **Limited fields**: Only name, phone, email exposed
|
||||
3. **Query limits**: Maximum 100 results per query
|
||||
4. **Audit logging**: All contact operations logged
|
||||
|
||||
### Privacy Features
|
||||
|
||||
1. **No account info**: Account type/name hidden
|
||||
2. **No photos**: Contact photos not accessible
|
||||
3. **Single values**: Only primary phone/email (no full list)
|
||||
4. **No sync metadata**: Internal sync state hidden
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After Milestone 17 passes:
|
||||
1. Milestone 18: Inter-App Communication
|
||||
@@ -30,6 +30,7 @@ add_library(mosis-sandbox STATIC
|
||||
../src/main/cpp/sandbox/location_interface.cpp
|
||||
../src/main/cpp/sandbox/sensor_interface.cpp
|
||||
../src/main/cpp/sandbox/bluetooth_interface.cpp
|
||||
../src/main/cpp/sandbox/contacts_interface.cpp
|
||||
)
|
||||
target_include_directories(mosis-sandbox PUBLIC
|
||||
../src/main/cpp/sandbox
|
||||
|
||||
@@ -20,6 +20,7 @@
|
||||
#include "location_interface.h"
|
||||
#include "sensor_interface.h"
|
||||
#include "bluetooth_interface.h"
|
||||
#include "contacts_interface.h"
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <sstream>
|
||||
@@ -2890,6 +2891,190 @@ bool Test_BluetoothLuaIntegration(std::string& error_msg) {
|
||||
return true;
|
||||
}
|
||||
|
||||
//=============================================================================
|
||||
// Milestone 17: Contacts
|
||||
//=============================================================================
|
||||
|
||||
bool Test_ContactsRequiresReadPermission(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
// No permission granted
|
||||
|
||||
std::string err;
|
||||
auto results = contacts.Query({}, err);
|
||||
|
||||
EXPECT_TRUE(results.empty());
|
||||
EXPECT_TRUE(err.find("permission") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsRequiresWritePermission(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true); // Read OK, but not write
|
||||
|
||||
std::string err;
|
||||
mosis::Contact contact;
|
||||
contact.name = "John Doe";
|
||||
contact.phone = "555-1234";
|
||||
contact.email = "john@test.com";
|
||||
int id = contacts.Add(contact, err);
|
||||
|
||||
EXPECT_TRUE(id == 0); // Failed
|
||||
EXPECT_TRUE(err.find("permission") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsQueryWorks(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
|
||||
// Set mock contacts
|
||||
std::vector<mosis::Contact> mockContacts = {
|
||||
{1, "John Doe", "555-1234", "john@test.com"},
|
||||
{2, "Jane Doe", "555-5678", "jane@test.com"},
|
||||
{3, "Bob Smith", "555-9999", "bob@test.com"}
|
||||
};
|
||||
contacts.SetMockContacts(mockContacts);
|
||||
|
||||
std::string err;
|
||||
mosis::QueryOptions opts;
|
||||
opts.search = "Doe";
|
||||
auto results = contacts.Query(opts, err);
|
||||
|
||||
EXPECT_TRUE(err.empty());
|
||||
EXPECT_TRUE(results.size() == 2); // John and Jane
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsQueryLimit(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
|
||||
// Set 50 mock contacts
|
||||
std::vector<mosis::Contact> mockContacts;
|
||||
for (int i = 0; i < 50; i++) {
|
||||
mosis::Contact c;
|
||||
c.id = i + 1;
|
||||
c.name = "Contact " + std::to_string(i);
|
||||
c.phone = "555-" + std::to_string(i);
|
||||
mockContacts.push_back(c);
|
||||
}
|
||||
contacts.SetMockContacts(mockContacts);
|
||||
|
||||
std::string err;
|
||||
|
||||
// Query with limit
|
||||
mosis::QueryOptions opts;
|
||||
opts.limit = 10;
|
||||
auto results = contacts.Query(opts, err);
|
||||
EXPECT_TRUE(results.size() == 10);
|
||||
|
||||
// Query with excessive limit (gets all contacts < MAX_RESULTS)
|
||||
opts.limit = 200;
|
||||
results = contacts.Query(opts, err);
|
||||
EXPECT_TRUE(results.size() == 50); // All contacts
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsCRUD(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetReadPermission(true);
|
||||
contacts.SetWritePermission(true);
|
||||
|
||||
std::string err;
|
||||
|
||||
// Add
|
||||
mosis::Contact newContact;
|
||||
newContact.name = "Test User";
|
||||
newContact.phone = "555-1111";
|
||||
newContact.email = "test@test.com";
|
||||
int id = contacts.Add(newContact, err);
|
||||
EXPECT_TRUE(id > 0);
|
||||
EXPECT_TRUE(err.empty());
|
||||
|
||||
// Read back
|
||||
auto contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(contact.has_value());
|
||||
EXPECT_TRUE(contact->name == "Test User");
|
||||
|
||||
// Update
|
||||
contact->name = "Updated User";
|
||||
contact->phone = "555-2222";
|
||||
bool updated = contacts.Update(*contact, err);
|
||||
EXPECT_TRUE(updated);
|
||||
|
||||
// Verify update
|
||||
contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(contact->name == "Updated User");
|
||||
EXPECT_TRUE(contact->phone == "555-2222");
|
||||
|
||||
// Delete
|
||||
bool deleted = contacts.Delete(id, err);
|
||||
EXPECT_TRUE(deleted);
|
||||
|
||||
// Verify deleted
|
||||
contact = contacts.GetById(id, err);
|
||||
EXPECT_TRUE(!contact.has_value());
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsDeleteNotFound(std::string& error_msg) {
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
contacts.SetWritePermission(true);
|
||||
|
||||
std::string err;
|
||||
bool deleted = contacts.Delete(99999, err);
|
||||
|
||||
EXPECT_TRUE(!deleted);
|
||||
EXPECT_TRUE(err.find("not found") != std::string::npos);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Test_ContactsLuaIntegration(std::string& error_msg) {
|
||||
SandboxContext ctx = TestContext();
|
||||
LuaSandbox sandbox(ctx);
|
||||
|
||||
mosis::ContactsInterface contacts("test.app");
|
||||
mosis::RegisterContactsAPI(sandbox.GetState(), &contacts);
|
||||
|
||||
std::string script = R"lua(
|
||||
-- Test that contacts global exists
|
||||
if not contacts then
|
||||
error("contacts global not found")
|
||||
end
|
||||
if not contacts.query then
|
||||
error("contacts.query not found")
|
||||
end
|
||||
if not contacts.getById then
|
||||
error("contacts.getById not found")
|
||||
end
|
||||
if not contacts.getCount then
|
||||
error("contacts.getCount not found")
|
||||
end
|
||||
if not contacts.add then
|
||||
error("contacts.add not found")
|
||||
end
|
||||
if not contacts.update then
|
||||
error("contacts.update not found")
|
||||
end
|
||||
if not contacts.delete then
|
||||
error("contacts.delete not found")
|
||||
end
|
||||
)lua";
|
||||
|
||||
bool ok = sandbox.LoadString(script, "contacts_test");
|
||||
if (!ok) {
|
||||
error_msg = "Lua test failed: " + sandbox.GetLastError();
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
//=============================================================================
|
||||
// MAIN
|
||||
//=============================================================================
|
||||
@@ -3082,6 +3267,15 @@ int main(int argc, char* argv[]) {
|
||||
harness.AddTest("BluetoothCleansUpOnShutdown", Test_BluetoothCleansUpOnShutdown);
|
||||
harness.AddTest("BluetoothLuaIntegration", Test_BluetoothLuaIntegration);
|
||||
|
||||
// Milestone 17: Contacts
|
||||
harness.AddTest("ContactsRequiresReadPermission", Test_ContactsRequiresReadPermission);
|
||||
harness.AddTest("ContactsRequiresWritePermission", Test_ContactsRequiresWritePermission);
|
||||
harness.AddTest("ContactsQueryWorks", Test_ContactsQueryWorks);
|
||||
harness.AddTest("ContactsQueryLimit", Test_ContactsQueryLimit);
|
||||
harness.AddTest("ContactsCRUD", Test_ContactsCRUD);
|
||||
harness.AddTest("ContactsDeleteNotFound", Test_ContactsDeleteNotFound);
|
||||
harness.AddTest("ContactsLuaIntegration", Test_ContactsLuaIntegration);
|
||||
|
||||
// Run tests
|
||||
auto results = harness.Run(filter);
|
||||
|
||||
|
||||
466
src/main/cpp/sandbox/contacts_interface.cpp
Normal file
466
src/main/cpp/sandbox/contacts_interface.cpp
Normal file
@@ -0,0 +1,466 @@
|
||||
// contacts_interface.cpp - Contacts interface implementation
|
||||
// Milestone 17: Contact access with granular read/write permissions
|
||||
|
||||
#include "contacts_interface.h"
|
||||
#include "lua_sandbox.h"
|
||||
#include <lua.hpp>
|
||||
#include <algorithm>
|
||||
#include <cctype>
|
||||
|
||||
namespace mosis {
|
||||
|
||||
// Helper: case-insensitive string search
|
||||
static bool ContainsIgnoreCase(const std::string& haystack, const std::string& needle) {
|
||||
if (needle.empty()) return true;
|
||||
if (haystack.empty()) return false;
|
||||
|
||||
auto it = std::search(
|
||||
haystack.begin(), haystack.end(),
|
||||
needle.begin(), needle.end(),
|
||||
[](char a, char b) {
|
||||
return std::tolower(static_cast<unsigned char>(a)) ==
|
||||
std::tolower(static_cast<unsigned char>(b));
|
||||
}
|
||||
);
|
||||
return it != haystack.end();
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// ContactsInterface
|
||||
// ============================================================================
|
||||
|
||||
ContactsInterface::ContactsInterface(const std::string& app_id)
|
||||
: m_app_id(app_id)
|
||||
{
|
||||
}
|
||||
|
||||
ContactsInterface::~ContactsInterface() = default;
|
||||
|
||||
bool ContactsInterface::MatchesSearch(const Contact& contact, const std::string& search) const {
|
||||
if (search.empty()) return true;
|
||||
|
||||
return ContainsIgnoreCase(contact.name, search) ||
|
||||
ContainsIgnoreCase(contact.phone, search) ||
|
||||
ContainsIgnoreCase(contact.email, search);
|
||||
}
|
||||
|
||||
std::vector<Contact> ContactsInterface::Query(const QueryOptions& options, std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_read_permission) {
|
||||
error = "permission denied: contacts.read required";
|
||||
return {};
|
||||
}
|
||||
|
||||
std::vector<Contact> results;
|
||||
|
||||
// Cap limit at MAX_RESULTS
|
||||
int limit = std::min(options.limit, MAX_RESULTS);
|
||||
if (limit <= 0) limit = 50;
|
||||
|
||||
int offset = std::max(options.offset, 0);
|
||||
|
||||
// Filter and paginate
|
||||
int skipped = 0;
|
||||
for (const auto& contact : m_mock_contacts) {
|
||||
if (MatchesSearch(contact, options.search)) {
|
||||
if (skipped < offset) {
|
||||
skipped++;
|
||||
continue;
|
||||
}
|
||||
results.push_back(contact);
|
||||
if (static_cast<int>(results.size()) >= limit) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
std::optional<Contact> ContactsInterface::GetById(int id, std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_read_permission) {
|
||||
error = "permission denied: contacts.read required";
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
for (const auto& contact : m_mock_contacts) {
|
||||
if (contact.id == id) {
|
||||
return contact;
|
||||
}
|
||||
}
|
||||
|
||||
error = "contact not found";
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
int ContactsInterface::Add(const Contact& contact, std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_write_permission) {
|
||||
error = "permission denied: contacts.write required";
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (contact.name.empty()) {
|
||||
error = "contact name is required";
|
||||
return 0;
|
||||
}
|
||||
|
||||
Contact newContact = contact;
|
||||
newContact.id = m_next_id++;
|
||||
|
||||
m_mock_contacts.push_back(newContact);
|
||||
return newContact.id;
|
||||
}
|
||||
|
||||
bool ContactsInterface::Update(const Contact& contact, std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_write_permission) {
|
||||
error = "permission denied: contacts.write required";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (contact.id <= 0) {
|
||||
error = "invalid contact id";
|
||||
return false;
|
||||
}
|
||||
|
||||
for (auto& c : m_mock_contacts) {
|
||||
if (c.id == contact.id) {
|
||||
c.name = contact.name;
|
||||
c.phone = contact.phone;
|
||||
c.email = contact.email;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
error = "contact not found";
|
||||
return false;
|
||||
}
|
||||
|
||||
bool ContactsInterface::Delete(int id, std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_write_permission) {
|
||||
error = "permission denied: contacts.write required";
|
||||
return false;
|
||||
}
|
||||
|
||||
auto it = std::find_if(m_mock_contacts.begin(), m_mock_contacts.end(),
|
||||
[id](const Contact& c) { return c.id == id; });
|
||||
|
||||
if (it == m_mock_contacts.end()) {
|
||||
error = "contact not found";
|
||||
return false;
|
||||
}
|
||||
|
||||
m_mock_contacts.erase(it);
|
||||
return true;
|
||||
}
|
||||
|
||||
int ContactsInterface::GetCount(std::string& error) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
|
||||
if (!m_has_read_permission) {
|
||||
error = "permission denied: contacts.read required";
|
||||
return -1;
|
||||
}
|
||||
|
||||
return static_cast<int>(m_mock_contacts.size());
|
||||
}
|
||||
|
||||
void ContactsInterface::SetMockContacts(const std::vector<Contact>& contacts) {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
m_mock_contacts = contacts;
|
||||
|
||||
// Update next ID to be higher than any existing ID
|
||||
m_next_id = 1;
|
||||
for (const auto& c : m_mock_contacts) {
|
||||
if (c.id >= m_next_id) {
|
||||
m_next_id = c.id + 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void ContactsInterface::ClearMockContacts() {
|
||||
std::lock_guard<std::mutex> lock(m_mutex);
|
||||
m_mock_contacts.clear();
|
||||
m_next_id = 1;
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Lua API
|
||||
// ============================================================================
|
||||
|
||||
// Helper to set a global in the real _G (bypassing any proxy)
|
||||
static void SetGlobalInRealG(lua_State* L, const char* name) {
|
||||
// Stack: value to set as global (at -1)
|
||||
lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS);
|
||||
|
||||
// Check if _G has a metatable with __index (sandbox proxy pattern)
|
||||
if (lua_getmetatable(L, -1)) {
|
||||
lua_getfield(L, -1, "__index");
|
||||
if (lua_istable(L, -1)) {
|
||||
// Found proxy, set in the real _G (__index table)
|
||||
lua_pushvalue(L, -4); // Copy value
|
||||
lua_setfield(L, -2, name);
|
||||
lua_pop(L, 4); // Pop __index, metatable, _G, original value
|
||||
return;
|
||||
}
|
||||
lua_pop(L, 2); // Pop nil/__index and metatable
|
||||
}
|
||||
|
||||
// No proxy, set in _G directly
|
||||
lua_pushvalue(L, -2); // Copy value
|
||||
lua_setfield(L, -2, name);
|
||||
lua_pop(L, 2); // Pop _G and original value
|
||||
}
|
||||
|
||||
static const char* CONTACTS_INTERFACE_KEY = "mosis.contacts_interface";
|
||||
|
||||
static ContactsInterface* GetContactsInterface(lua_State* L) {
|
||||
lua_getfield(L, LUA_REGISTRYINDEX, CONTACTS_INTERFACE_KEY);
|
||||
auto* contacts = static_cast<ContactsInterface*>(lua_touserdata(L, -1));
|
||||
lua_pop(L, 1);
|
||||
return contacts;
|
||||
}
|
||||
|
||||
// Push Contact as Lua table
|
||||
static void PushContact(lua_State* L, const Contact& contact) {
|
||||
lua_createtable(L, 0, 4);
|
||||
|
||||
lua_pushinteger(L, contact.id);
|
||||
lua_setfield(L, -2, "id");
|
||||
|
||||
lua_pushstring(L, contact.name.c_str());
|
||||
lua_setfield(L, -2, "name");
|
||||
|
||||
lua_pushstring(L, contact.phone.c_str());
|
||||
lua_setfield(L, -2, "phone");
|
||||
|
||||
lua_pushstring(L, contact.email.c_str());
|
||||
lua_setfield(L, -2, "email");
|
||||
}
|
||||
|
||||
// Read Contact from Lua table at given index
|
||||
static Contact ReadContact(lua_State* L, int index) {
|
||||
Contact contact;
|
||||
|
||||
if (lua_type(L, index) != LUA_TTABLE) {
|
||||
return contact;
|
||||
}
|
||||
|
||||
lua_getfield(L, index, "id");
|
||||
if (lua_isinteger(L, -1)) {
|
||||
contact.id = static_cast<int>(lua_tointeger(L, -1));
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
lua_getfield(L, index, "name");
|
||||
if (lua_isstring(L, -1)) {
|
||||
contact.name = lua_tostring(L, -1);
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
lua_getfield(L, index, "phone");
|
||||
if (lua_isstring(L, -1)) {
|
||||
contact.phone = lua_tostring(L, -1);
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
lua_getfield(L, index, "email");
|
||||
if (lua_isstring(L, -1)) {
|
||||
contact.email = lua_tostring(L, -1);
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
return contact;
|
||||
}
|
||||
|
||||
// contacts.query(options) -> array of contacts
|
||||
static int lua_contacts_query(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
QueryOptions options;
|
||||
|
||||
// Parse options table (optional)
|
||||
if (lua_gettop(L) >= 1 && lua_istable(L, 1)) {
|
||||
lua_getfield(L, 1, "search");
|
||||
if (lua_isstring(L, -1)) {
|
||||
options.search = lua_tostring(L, -1);
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
lua_getfield(L, 1, "limit");
|
||||
if (lua_isinteger(L, -1)) {
|
||||
options.limit = static_cast<int>(lua_tointeger(L, -1));
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
|
||||
lua_getfield(L, 1, "offset");
|
||||
if (lua_isinteger(L, -1)) {
|
||||
options.offset = static_cast<int>(lua_tointeger(L, -1));
|
||||
}
|
||||
lua_pop(L, 1);
|
||||
}
|
||||
|
||||
std::string error;
|
||||
auto results = contacts->Query(options, error);
|
||||
|
||||
if (!error.empty()) {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
// Return array of contacts
|
||||
lua_createtable(L, static_cast<int>(results.size()), 0);
|
||||
for (size_t i = 0; i < results.size(); i++) {
|
||||
PushContact(L, results[i]);
|
||||
lua_rawseti(L, -2, static_cast<int>(i + 1));
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
// contacts.getById(id) -> contact or nil
|
||||
static int lua_contacts_getById(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
int id = static_cast<int>(luaL_checkinteger(L, 1));
|
||||
|
||||
std::string error;
|
||||
auto contact = contacts->GetById(id, error);
|
||||
|
||||
if (!error.empty() && error != "contact not found") {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
if (contact) {
|
||||
PushContact(L, *contact);
|
||||
} else {
|
||||
lua_pushnil(L);
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
// contacts.getCount() -> number
|
||||
static int lua_contacts_getCount(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
std::string error;
|
||||
int count = contacts->GetCount(error);
|
||||
|
||||
if (!error.empty()) {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
lua_pushinteger(L, count);
|
||||
return 1;
|
||||
}
|
||||
|
||||
// contacts.add(contact) -> id
|
||||
static int lua_contacts_add(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
luaL_checktype(L, 1, LUA_TTABLE);
|
||||
Contact contact = ReadContact(L, 1);
|
||||
|
||||
std::string error;
|
||||
int id = contacts->Add(contact, error);
|
||||
|
||||
if (!error.empty()) {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
lua_pushinteger(L, id);
|
||||
return 1;
|
||||
}
|
||||
|
||||
// contacts.update(contact) -> boolean
|
||||
static int lua_contacts_update(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
luaL_checktype(L, 1, LUA_TTABLE);
|
||||
Contact contact = ReadContact(L, 1);
|
||||
|
||||
std::string error;
|
||||
bool success = contacts->Update(contact, error);
|
||||
|
||||
if (!error.empty() && !success) {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
lua_pushboolean(L, success);
|
||||
return 1;
|
||||
}
|
||||
|
||||
// contacts.delete(id) -> boolean
|
||||
static int lua_contacts_delete(lua_State* L) {
|
||||
auto* contacts = GetContactsInterface(L);
|
||||
if (!contacts) {
|
||||
return luaL_error(L, "contacts interface not available");
|
||||
}
|
||||
|
||||
int id = static_cast<int>(luaL_checkinteger(L, 1));
|
||||
|
||||
std::string error;
|
||||
bool success = contacts->Delete(id, error);
|
||||
|
||||
if (!error.empty() && !success) {
|
||||
return luaL_error(L, "%s", error.c_str());
|
||||
}
|
||||
|
||||
lua_pushboolean(L, success);
|
||||
return 1;
|
||||
}
|
||||
|
||||
void RegisterContactsAPI(lua_State* L, ContactsInterface* contacts) {
|
||||
// Store interface pointer
|
||||
lua_pushlightuserdata(L, contacts);
|
||||
lua_setfield(L, LUA_REGISTRYINDEX, CONTACTS_INTERFACE_KEY);
|
||||
|
||||
// Create contacts table
|
||||
lua_createtable(L, 0, 6);
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_query);
|
||||
lua_setfield(L, -2, "query");
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_getById);
|
||||
lua_setfield(L, -2, "getById");
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_getCount);
|
||||
lua_setfield(L, -2, "getCount");
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_add);
|
||||
lua_setfield(L, -2, "add");
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_update);
|
||||
lua_setfield(L, -2, "update");
|
||||
|
||||
lua_pushcfunction(L, lua_contacts_delete);
|
||||
lua_setfield(L, -2, "delete");
|
||||
|
||||
// Set as global "contacts" (bypassing sandbox proxy)
|
||||
SetGlobalInRealG(L, "contacts");
|
||||
}
|
||||
|
||||
} // namespace mosis
|
||||
94
src/main/cpp/sandbox/contacts_interface.h
Normal file
94
src/main/cpp/sandbox/contacts_interface.h
Normal file
@@ -0,0 +1,94 @@
|
||||
// contacts_interface.h - Contacts interface for Lua sandbox
|
||||
// Milestone 17: Contact access with granular read/write permissions
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <optional>
|
||||
#include <functional>
|
||||
#include <mutex>
|
||||
#include <unordered_map>
|
||||
|
||||
struct lua_State;
|
||||
|
||||
namespace mosis {
|
||||
|
||||
struct Contact {
|
||||
int id = 0; // Internal ID
|
||||
std::string name; // Display name
|
||||
std::string phone; // Primary phone number
|
||||
std::string email; // Primary email
|
||||
};
|
||||
|
||||
struct QueryOptions {
|
||||
std::string search; // Search string (matches name, phone, email)
|
||||
int limit = 50; // Max results (capped at 100)
|
||||
int offset = 0; // Pagination offset
|
||||
};
|
||||
|
||||
enum class ContactsError {
|
||||
None,
|
||||
PermissionDenied,
|
||||
NotFound,
|
||||
InvalidData,
|
||||
LimitExceeded
|
||||
};
|
||||
|
||||
class ContactsInterface {
|
||||
public:
|
||||
ContactsInterface(const std::string& app_id);
|
||||
~ContactsInterface();
|
||||
|
||||
// Permission checks
|
||||
bool HasReadPermission() const { return m_has_read_permission; }
|
||||
void SetReadPermission(bool granted) { m_has_read_permission = granted; }
|
||||
|
||||
bool HasWritePermission() const { return m_has_write_permission; }
|
||||
void SetWritePermission(bool granted) { m_has_write_permission = granted; }
|
||||
|
||||
// Query contacts (requires read permission)
|
||||
std::vector<Contact> Query(const QueryOptions& options, std::string& error);
|
||||
|
||||
// Get single contact by ID (requires read permission)
|
||||
std::optional<Contact> GetById(int id, std::string& error);
|
||||
|
||||
// Add contact (requires write permission)
|
||||
int Add(const Contact& contact, std::string& error);
|
||||
|
||||
// Update contact (requires write permission)
|
||||
bool Update(const Contact& contact, std::string& error);
|
||||
|
||||
// Delete contact (requires write permission)
|
||||
bool Delete(int id, std::string& error);
|
||||
|
||||
// Get total contact count (requires read permission)
|
||||
int GetCount(std::string& error);
|
||||
|
||||
// For testing
|
||||
void SetMockMode(bool enabled) { m_mock_mode = enabled; }
|
||||
bool IsMockMode() const { return m_mock_mode; }
|
||||
|
||||
// Mock mode: set contacts directly
|
||||
void SetMockContacts(const std::vector<Contact>& contacts);
|
||||
|
||||
// Clear all mock contacts
|
||||
void ClearMockContacts();
|
||||
|
||||
private:
|
||||
std::string m_app_id;
|
||||
bool m_mock_mode = true;
|
||||
bool m_has_read_permission = false;
|
||||
bool m_has_write_permission = false;
|
||||
std::vector<Contact> m_mock_contacts;
|
||||
int m_next_id = 1;
|
||||
mutable std::mutex m_mutex;
|
||||
|
||||
static constexpr int MAX_RESULTS = 100;
|
||||
|
||||
bool MatchesSearch(const Contact& contact, const std::string& search) const;
|
||||
};
|
||||
|
||||
// Register contacts.* APIs as globals
|
||||
void RegisterContactsAPI(lua_State* L, ContactsInterface* contacts);
|
||||
|
||||
} // namespace mosis
|
||||
Reference in New Issue
Block a user